hibento
hibento

Reputation: 884

umbrella header for module 'myFramework' does not include header 'otherFramework.h'

My Swift / iOS9 framework 'viewer_protocol' uses another and external Objective-C framework (CocoaAsyncSocket). I'm using Carthage to build CocoaAsyncSocket. So far everything works fine: In have an example App inside my framework Xcode Project using my framework without any problems.

Now I want to use my Framework in a different Xcode Project - although using Carthage. I include only my Framework as a dependency and Carthage automatically resolves the dependencies to CocoaAsyncSocket. I embedded both frameworks into this new Xcode Project and build my App: Everything works fine here - except one warning I can't rid off:

/Users/John/Repositories/my_project/<module-includes>:1:1: 
Umbrella header for module 'my_project' does not include header 'GCDAsyncSocket.h'

This is my framework header:

#import <UIKit/UIKit.h>

//! Project version number for my_project.
FOUNDATION_EXPORT double my_projectVersionNumber;

//! Project version string for my_project.
FOUNDATION_EXPORT const unsigned char my_projectVersionString[];

// In this header, you should import all the public headers of your framework     
using statements like #import <my_project/PublicHeader.h>
#import <CocoaAsyncSocket/CocoaAsyncSocket.h>

As you can see CocoaAsyncSocket.h is imported. Furthermore inside my framework the CocoaAsyncSocket.h file is included:

my framework's folder

What I am missing here? I'm using several others external frameworks inside my framework, there're no warnings for them - all of these external frameworks are written in Swift - CocoaAsyncSocket is pure Objective-C.

This is my frameworks module.modulemap:

 framework module my_project {
   umbrella header "my_project.h"

   export *
   module * { export * }
 }

 module viewer_protocol.Swift {
     header "my_project-Swift.h"
 }

Update

I found a solution: Changing the import statement in my framework header from

#import <CocoaAsyncSocket/CocoaAsyncSocket.h>

to

#import "CocoaAsyncSocket/CocoaAsyncSocket.h"

Now Xcode finds the header file and the warning disappears.

Upvotes: 65

Views: 50008

Answers (14)

th_in_gs
th_in_gs

Reputation: 549

An error like this was driving me crazy for a while this afternoon.

It turned out that my umbrella header - the global one with all the imports of public headers in it - had somehow got set to be Private. This caused the module verifier to complain about all the headers included by it - which were actually fine - rather than about the global header itself.

Switching it back to Public fixed the problem.

Upvotes: 0

ersegun
ersegun

Reputation: 81

Deleting DerivedData did the trick for me. Try running the below command and see if it works.

rm -rf ~/Library/Developer/Xcode/DerivedData

Upvotes: 1

Senseful
Senseful

Reputation: 91681

I had the same issue. Seemed to be related to old build files.

The standard Xcode problem fixer worked for me:

  1. Clean project (Product > Clean Build Folder)
  2. Deleted derived data
  3. Restart Xcode

Upvotes: 30

swiftBoy
swiftBoy

Reputation: 35783

I had the same issue today

Umbrella header for module 'HockeySDK' does not include header 'BITHockeyBaseViewController.h'

and the solution was

1.build and run project and go-to Report Navigator

2.look at the warning, click to expand details

it will so you the file name where you need to make change as you can seen in below screen shot

enter image description here

So i just updated my import statement in AppDelegate.m file

New

#import "HockeySDK/HockeySDK.h"

Old

#import <HockeySDK/HockeySDK.h>

and issue gone..

hope this will help someone. who are coming here for solution.

Upvotes: 27

szubiszon
szubiszon

Reputation: 106

In my case (Obj-c framework):

Umbrella header for module 'opus' does not include header 'opus_multistream.h'

I needed to change:

@import opus.opus_defines;

into

@import opus;

(I don't have in #import "....h" or #import <....h> for frameworks)

Upvotes: 1

user1105951
user1105951

Reputation: 2287

For others : In my case I already move the headers I want to expose from my framework, from "project" to "public" (Build phases of the framework target)

Then Xcode gave my this warning.

Xcode is telling us that we also need to add #import "name of header in the warning> in the public header file that was created with framework, so the clients (of the framework) will know this header.

So The Fix:
1.go to the framework public header file.(the one what created by xcode when you created the framework) .
2. add #import "the-name-of-the-header-in-the-warning.h"

Upvotes: 1

mjl007
mjl007

Reputation: 775

Take a look at this post:

@import vs #import - iOS 7

It goes over the concepts of the new module importing. I had my own custom framework and after adopting the new method to import objective-c framework

old: #import <MyFramework/MyFramework.h>

new: @import MyFramework;

it took care of the warning/

Upvotes: 0

iwasrobbed
iwasrobbed

Reputation: 46703

Alternatively, you may have exposed files within the Public area of your framework's build phases that should actually be moved back to the Project area.

If you don't want those files to be within your framework's umbrella header so they're publicly accessible, you can revert this.

Goto Framework -> Target -> Build Phases and drag to move the unnecessary header files from Public to Project.

Screenshot

Upvotes: 14

AnneTheAgile
AnneTheAgile

Reputation: 10250

We got this recently and it was due to corruption in DerivedData. Deleting that folder fixed the problem.

Upvotes: 6

jarora
jarora

Reputation: 5762

For me the fix was rather simple, commit all your changes and build again. The warning disappeared.

Upvotes: -2

greenhouse
greenhouse

Reputation: 1281

trying to fix a archive build error led me to this error and post

my solution was real simple but took forever for me to figure out.

  • when i ran $ pod install it generated a workspace for me in the same dir as my .xcodeproj file.
  • however i had already created a workspace to use as its parent directory.
  • so then i simply deleted my old workspace and went with the one that pods created

enter image description here


hope this helps someone! glhf!

Upvotes: -1

AyJay
AyJay

Reputation: 548

I recently ran into same issue. Apparently I had header file set as public in target membership, but it was not exposed in umbrella header. Fixed issue by making header file with project access instead of public.

Upvotes: 49

pflous
pflous

Reputation: 571

Just for completeness if your header is set to public in :

Build Phases > Headers

You should either

Include the import in your main header as others have mentioned

OR

Move that header to "private" if it doesn't need to be exposed

Upvotes: 7

Oded Regev
Oded Regev

Reputation: 4405

For me the solution was as follows:

1) Each Objective C framework has 1 header file that contains all the:

#import ...
#import ...
#import ...

2) Make sure that this file imports the missing header.

3) Build the project again, it should remove the warning.

Upvotes: 16

Related Questions