Better support for using the proto library from a framework.

- Add generator constant for the default framework name.
- Add generator api for making the CPP symbol from the name.
- Add generator api to see if it is a bundled proto file.
- Output a CPP conditional and two imports for the core library headers.
- Add helper for generating the #import for file headers to deal with the
  framework imports.
- Add a reference from the unittests to a WKT to use that to inspect how
  imports generate.
- Update the podspec to define the CPP symbol and require pods 1.0 (or later).

Fixes https://github.com/google/protobuf/issues/1457

Protobuf.podspec

@@ -10,6 +10,7 @@ Pod::Spec.new do |s|
   s.homepage = 'https://github.com/google/protobuf'
   s.license  = 'New BSD'
   s.authors  = { 'The Protocol Buffers contributors' => 'protobuf@googlegroups.com' }
+  s.cocoapods_version = '>= 1.0'
 
   s.source = { :git => 'https://github.com/google/protobuf.git',
                :tag => "v#{s.version}" }
@@ -32,7 +33,10 @@ Pod::Spec.new do |s|
   # The following would cause duplicate symbol definitions. GPBProtocolBuffers is expected to be
   # left out, as it's an umbrella implementation file.
   s.exclude_files = 'objectivec/GPBProtocolBuffers.m'
-  s.header_mappings_dir = 'objectivec'
+
+  # Set a CPP symbol so the code knows to use framework imports.
+  s.user_target_xcconfig = { 'GCC_PREPROCESSOR_DEFINITIONS' => '$(inherited) GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS=1' }
+  s.pod_target_xcconfig = { 'GCC_PREPROCESSOR_DEFINITIONS' => '$(inherited) GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS=1' }
 
   s.ios.deployment_target = '7.1'
   s.osx.deployment_target = '10.9'

objectivec/GPBProtocolBuffers.h

@@ -44,14 +44,33 @@
 #import "GPBWellKnownTypes.h"
 #import "GPBWireFormat.h"
 
+// This CPP symbol can be defined to use imports that match up to the framework
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
 // Well-known proto types
-#import "google/protobuf/Any.pbobjc.h"
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
-#import "google/protobuf/Api.pbobjc.h"
+ #import <Protobuf/Any.pbobjc.h>
-#import "google/protobuf/Duration.pbobjc.h"
+ #import <Protobuf/Api.pbobjc.h>
-#import "google/protobuf/Empty.pbobjc.h"
+ #import <Protobuf/Duration.pbobjc.h>
-#import "google/protobuf/FieldMask.pbobjc.h"
+ #import <Protobuf/Empty.pbobjc.h>
-#import "google/protobuf/SourceContext.pbobjc.h"
+ #import <Protobuf/FieldMask.pbobjc.h>
-#import "google/protobuf/Struct.pbobjc.h"
+ #import <Protobuf/SourceContext.pbobjc.h>
-#import "google/protobuf/Timestamp.pbobjc.h"
+ #import <Protobuf/Struct.pbobjc.h>
-#import "google/protobuf/Type.pbobjc.h"
+ #import <Protobuf/Timestamp.pbobjc.h>
-#import "google/protobuf/Wrappers.pbobjc.h"
+ #import <Protobuf/Type.pbobjc.h>
+ #import <Protobuf/Wrappers.pbobjc.h>
+#else
+ #import "google/protobuf/Any.pbobjc.h"
+ #import "google/protobuf/Api.pbobjc.h"
+ #import "google/protobuf/Duration.pbobjc.h"
+ #import "google/protobuf/Empty.pbobjc.h"
+ #import "google/protobuf/FieldMask.pbobjc.h"
+ #import "google/protobuf/SourceContext.pbobjc.h"
+ #import "google/protobuf/Struct.pbobjc.h"
+ #import "google/protobuf/Timestamp.pbobjc.h"
+ #import "google/protobuf/Type.pbobjc.h"
+ #import "google/protobuf/Wrappers.pbobjc.h"
+#endif

objectivec/GPBWellKnownTypes.h

@@ -30,8 +30,19 @@
 
 #import <Foundation/Foundation.h>
 
-#import "google/protobuf/Duration.pbobjc.h"
+// This CPP symbol can be defined to use imports that match up to the framework
-#import "google/protobuf/Timestamp.pbobjc.h"
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/Duration.pbobjc.h>
+ #import <Protobuf/Timestamp.pbobjc.h>
+#else
+ #import "google/protobuf/Duration.pbobjc.h"
+ #import "google/protobuf/Timestamp.pbobjc.h"
+#endif
 
 NS_ASSUME_NONNULL_BEGIN
 

objectivec/Tests/unittest_objc.proto

@@ -29,6 +29,7 @@
 
 syntax = "proto2";
 
+import "google/protobuf/any.proto";
 import "google/protobuf/unittest.proto";
 
 package protobuf_unittest;
@@ -447,3 +448,11 @@ message BoolOnlyMessage {
   optional bool bool_field_31 = 31;
   optional bool bool_field_32 = 32;
 }
+
+// Reference to a WKT to test (via generated code inspection), the handling
+// of #imports.  Within the WKTs, references to each other are just path
+// based imports, but when reference from another proto file, they should be
+// conditional to support the framework import style.
+message WKTRefereceMessage {
+  optional google.protobuf.Any an_any = 1;
+}

objectivec/google/protobuf/Any.pbobjc.h

@@ -1,7 +1,17 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/any.proto
 
-#import "GPBProtocolBuffers.h"
+// This CPP symbol can be defined to use imports that match up to the framework
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers.h>
+#else
+ #import "GPBProtocolBuffers.h"
+#endif
 
 #if GOOGLE_PROTOBUF_OBJC_GEN_VERSION != 30001
 #error This file was generated by a different version of protoc which is incompatible with your Protocol Buffer library sources.

objectivec/google/protobuf/Any.pbobjc.m

@@ -1,8 +1,23 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/any.proto
 
-#import "GPBProtocolBuffers_RuntimeSupport.h"
+// This CPP symbol can be defined to use imports that match up to the framework
-#import "google/protobuf/Any.pbobjc.h"
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers_RuntimeSupport.h>
+#else
+ #import "GPBProtocolBuffers_RuntimeSupport.h"
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/Any.pbobjc.h>
+#else
+ #import "google/protobuf/Any.pbobjc.h"
+#endif
 // @@protoc_insertion_point(imports)
 
 #pragma clang diagnostic push

objectivec/google/protobuf/Api.pbobjc.h

@@ -1,7 +1,17 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/api.proto
 
-#import "GPBProtocolBuffers.h"
+// This CPP symbol can be defined to use imports that match up to the framework
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers.h>
+#else
+ #import "GPBProtocolBuffers.h"
+#endif
 
 #if GOOGLE_PROTOBUF_OBJC_GEN_VERSION != 30001
 #error This file was generated by a different version of protoc which is incompatible with your Protocol Buffer library sources.

objectivec/google/protobuf/Api.pbobjc.m

@@ -1,10 +1,27 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/api.proto
 
-#import "GPBProtocolBuffers_RuntimeSupport.h"
+// This CPP symbol can be defined to use imports that match up to the framework
-#import "google/protobuf/Api.pbobjc.h"
+// imports needed when using CocoaPods.
-#import "google/protobuf/SourceContext.pbobjc.h"
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
-#import "google/protobuf/Type.pbobjc.h"
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers_RuntimeSupport.h>
+#else
+ #import "GPBProtocolBuffers_RuntimeSupport.h"
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/Api.pbobjc.h>
+ #import <Protobuf/SourceContext.pbobjc.h>
+ #import <Protobuf/Type.pbobjc.h>
+#else
+ #import "google/protobuf/Api.pbobjc.h"
+ #import "google/protobuf/SourceContext.pbobjc.h"
+ #import "google/protobuf/Type.pbobjc.h"
+#endif
 // @@protoc_insertion_point(imports)
 
 #pragma clang diagnostic push

objectivec/google/protobuf/Duration.pbobjc.h

@@ -1,7 +1,17 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/duration.proto
 
-#import "GPBProtocolBuffers.h"
+// This CPP symbol can be defined to use imports that match up to the framework
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers.h>
+#else
+ #import "GPBProtocolBuffers.h"
+#endif
 
 #if GOOGLE_PROTOBUF_OBJC_GEN_VERSION != 30001
 #error This file was generated by a different version of protoc which is incompatible with your Protocol Buffer library sources.

objectivec/google/protobuf/Duration.pbobjc.m

@@ -1,8 +1,23 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/duration.proto
 
-#import "GPBProtocolBuffers_RuntimeSupport.h"
+// This CPP symbol can be defined to use imports that match up to the framework
-#import "google/protobuf/Duration.pbobjc.h"
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers_RuntimeSupport.h>
+#else
+ #import "GPBProtocolBuffers_RuntimeSupport.h"
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/Duration.pbobjc.h>
+#else
+ #import "google/protobuf/Duration.pbobjc.h"
+#endif
 // @@protoc_insertion_point(imports)
 
 #pragma clang diagnostic push

objectivec/google/protobuf/Empty.pbobjc.h

@@ -1,7 +1,17 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/empty.proto
 
-#import "GPBProtocolBuffers.h"
+// This CPP symbol can be defined to use imports that match up to the framework
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers.h>
+#else
+ #import "GPBProtocolBuffers.h"
+#endif
 
 #if GOOGLE_PROTOBUF_OBJC_GEN_VERSION != 30001
 #error This file was generated by a different version of protoc which is incompatible with your Protocol Buffer library sources.

objectivec/google/protobuf/Empty.pbobjc.m

@@ -1,8 +1,23 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/empty.proto
 
-#import "GPBProtocolBuffers_RuntimeSupport.h"
+// This CPP symbol can be defined to use imports that match up to the framework
-#import "google/protobuf/Empty.pbobjc.h"
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers_RuntimeSupport.h>
+#else
+ #import "GPBProtocolBuffers_RuntimeSupport.h"
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/Empty.pbobjc.h>
+#else
+ #import "google/protobuf/Empty.pbobjc.h"
+#endif
 // @@protoc_insertion_point(imports)
 
 #pragma clang diagnostic push

objectivec/google/protobuf/FieldMask.pbobjc.h

@@ -1,7 +1,17 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/field_mask.proto
 
-#import "GPBProtocolBuffers.h"
+// This CPP symbol can be defined to use imports that match up to the framework
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers.h>
+#else
+ #import "GPBProtocolBuffers.h"
+#endif
 
 #if GOOGLE_PROTOBUF_OBJC_GEN_VERSION != 30001
 #error This file was generated by a different version of protoc which is incompatible with your Protocol Buffer library sources.

objectivec/google/protobuf/FieldMask.pbobjc.m

@@ -1,8 +1,23 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/field_mask.proto
 
-#import "GPBProtocolBuffers_RuntimeSupport.h"
+// This CPP symbol can be defined to use imports that match up to the framework
-#import "google/protobuf/FieldMask.pbobjc.h"
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers_RuntimeSupport.h>
+#else
+ #import "GPBProtocolBuffers_RuntimeSupport.h"
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/FieldMask.pbobjc.h>
+#else
+ #import "google/protobuf/FieldMask.pbobjc.h"
+#endif
 // @@protoc_insertion_point(imports)
 
 #pragma clang diagnostic push

objectivec/google/protobuf/SourceContext.pbobjc.h

@@ -1,7 +1,17 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/source_context.proto
 
-#import "GPBProtocolBuffers.h"
+// This CPP symbol can be defined to use imports that match up to the framework
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers.h>
+#else
+ #import "GPBProtocolBuffers.h"
+#endif
 
 #if GOOGLE_PROTOBUF_OBJC_GEN_VERSION != 30001
 #error This file was generated by a different version of protoc which is incompatible with your Protocol Buffer library sources.

objectivec/google/protobuf/SourceContext.pbobjc.m

@@ -1,8 +1,23 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/source_context.proto
 
-#import "GPBProtocolBuffers_RuntimeSupport.h"
+// This CPP symbol can be defined to use imports that match up to the framework
-#import "google/protobuf/SourceContext.pbobjc.h"
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers_RuntimeSupport.h>
+#else
+ #import "GPBProtocolBuffers_RuntimeSupport.h"
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/SourceContext.pbobjc.h>
+#else
+ #import "google/protobuf/SourceContext.pbobjc.h"
+#endif
 // @@protoc_insertion_point(imports)
 
 #pragma clang diagnostic push

objectivec/google/protobuf/Struct.pbobjc.h

@@ -1,7 +1,17 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/struct.proto
 
-#import "GPBProtocolBuffers.h"
+// This CPP symbol can be defined to use imports that match up to the framework
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers.h>
+#else
+ #import "GPBProtocolBuffers.h"
+#endif
 
 #if GOOGLE_PROTOBUF_OBJC_GEN_VERSION != 30001
 #error This file was generated by a different version of protoc which is incompatible with your Protocol Buffer library sources.

objectivec/google/protobuf/Struct.pbobjc.m

@@ -1,8 +1,23 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/struct.proto
 
-#import "GPBProtocolBuffers_RuntimeSupport.h"
+// This CPP symbol can be defined to use imports that match up to the framework
-#import "google/protobuf/Struct.pbobjc.h"
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers_RuntimeSupport.h>
+#else
+ #import "GPBProtocolBuffers_RuntimeSupport.h"
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/Struct.pbobjc.h>
+#else
+ #import "google/protobuf/Struct.pbobjc.h"
+#endif
 // @@protoc_insertion_point(imports)
 
 #pragma clang diagnostic push

objectivec/google/protobuf/Timestamp.pbobjc.h

@@ -1,7 +1,17 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/timestamp.proto
 
-#import "GPBProtocolBuffers.h"
+// This CPP symbol can be defined to use imports that match up to the framework
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers.h>
+#else
+ #import "GPBProtocolBuffers.h"
+#endif
 
 #if GOOGLE_PROTOBUF_OBJC_GEN_VERSION != 30001
 #error This file was generated by a different version of protoc which is incompatible with your Protocol Buffer library sources.

objectivec/google/protobuf/Timestamp.pbobjc.m

@@ -1,8 +1,23 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/timestamp.proto
 
-#import "GPBProtocolBuffers_RuntimeSupport.h"
+// This CPP symbol can be defined to use imports that match up to the framework
-#import "google/protobuf/Timestamp.pbobjc.h"
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers_RuntimeSupport.h>
+#else
+ #import "GPBProtocolBuffers_RuntimeSupport.h"
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/Timestamp.pbobjc.h>
+#else
+ #import "google/protobuf/Timestamp.pbobjc.h"
+#endif
 // @@protoc_insertion_point(imports)
 
 #pragma clang diagnostic push

objectivec/google/protobuf/Type.pbobjc.h

@@ -1,7 +1,17 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/type.proto
 
-#import "GPBProtocolBuffers.h"
+// This CPP symbol can be defined to use imports that match up to the framework
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers.h>
+#else
+ #import "GPBProtocolBuffers.h"
+#endif
 
 #if GOOGLE_PROTOBUF_OBJC_GEN_VERSION != 30001
 #error This file was generated by a different version of protoc which is incompatible with your Protocol Buffer library sources.

objectivec/google/protobuf/Type.pbobjc.m

@@ -1,10 +1,27 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/type.proto
 
-#import "GPBProtocolBuffers_RuntimeSupport.h"
+// This CPP symbol can be defined to use imports that match up to the framework
-#import "google/protobuf/Type.pbobjc.h"
+// imports needed when using CocoaPods.
-#import "google/protobuf/Any.pbobjc.h"
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
-#import "google/protobuf/SourceContext.pbobjc.h"
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers_RuntimeSupport.h>
+#else
+ #import "GPBProtocolBuffers_RuntimeSupport.h"
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/Type.pbobjc.h>
+ #import <Protobuf/Any.pbobjc.h>
+ #import <Protobuf/SourceContext.pbobjc.h>
+#else
+ #import "google/protobuf/Type.pbobjc.h"
+ #import "google/protobuf/Any.pbobjc.h"
+ #import "google/protobuf/SourceContext.pbobjc.h"
+#endif
 // @@protoc_insertion_point(imports)
 
 #pragma clang diagnostic push

objectivec/google/protobuf/Wrappers.pbobjc.h

@@ -1,7 +1,17 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/wrappers.proto
 
-#import "GPBProtocolBuffers.h"
+// This CPP symbol can be defined to use imports that match up to the framework
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers.h>
+#else
+ #import "GPBProtocolBuffers.h"
+#endif
 
 #if GOOGLE_PROTOBUF_OBJC_GEN_VERSION != 30001
 #error This file was generated by a different version of protoc which is incompatible with your Protocol Buffer library sources.

objectivec/google/protobuf/Wrappers.pbobjc.m

@@ -1,8 +1,23 @@
 // Generated by the protocol buffer compiler.  DO NOT EDIT!
 // source: google/protobuf/wrappers.proto
 
-#import "GPBProtocolBuffers_RuntimeSupport.h"
+// This CPP symbol can be defined to use imports that match up to the framework
-#import "google/protobuf/Wrappers.pbobjc.h"
+// imports needed when using CocoaPods.
+#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS)
+ #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/GPBProtocolBuffers_RuntimeSupport.h>
+#else
+ #import "GPBProtocolBuffers_RuntimeSupport.h"
+#endif
+
+#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS
+ #import <Protobuf/Wrappers.pbobjc.h>
+#else
+ #import "google/protobuf/Wrappers.pbobjc.h"
+#endif
 // @@protoc_insertion_point(imports)
 
 #pragma clang diagnostic push

src/google/protobuf/compiler/objectivec/objectivec_file.cc

@@ -50,6 +50,80 @@ const int32 GOOGLE_PROTOBUF_OBJC_GEN_VERSION = 30001;
 namespace compiler {
 namespace objectivec {
 
+namespace {
+
+class ImportWriter {
+ public:
+  ImportWriter() {}
+
+  void AddFile(const FileGenerator* file);
+  void Print(io::Printer *printer) const;
+
+ private:
+  vector<string> protobuf_framework_imports_;
+  vector<string> protobuf_non_framework_imports_;
+  vector<string> other_imports_;
+};
+
+void ImportWriter::AddFile(const FileGenerator* file) {
+  const FileDescriptor* file_descriptor = file->Descriptor();
+  const string extension(".pbobjc.h");
+  if (IsProtobufLibraryBundledProtoFile(file_descriptor)) {
+    protobuf_framework_imports_.push_back(
+        FilePathBasename(file_descriptor) + extension);
+    protobuf_non_framework_imports_.push_back(file->Path() + extension);
+  } else {
+    other_imports_.push_back(file->Path() + extension);
+  }
+}
+
+void ImportWriter::Print(io::Printer *printer) const {
+  assert(protobuf_non_framework_imports_.size() ==
+         protobuf_framework_imports_.size());
+
+  if (protobuf_framework_imports_.size() > 0) {
+    const string framework_name(ProtobufLibraryFrameworkName);
+    const string cpp_symbol(ProtobufFrameworkImportSymbol(framework_name));
+
+    printer->Print(
+        "#if $cpp_symbol$\n",
+        "cpp_symbol", cpp_symbol);
+    for (vector<string>::const_iterator iter = protobuf_framework_imports_.begin();
+         iter != protobuf_framework_imports_.end(); ++iter) {
+      printer->Print(
+          " #import <$framework_name$/$header$>\n",
+          "framework_name", framework_name,
+          "header", *iter);
+    }
+    printer->Print(
+        "#else\n");
+    for (vector<string>::const_iterator iter = protobuf_non_framework_imports_.begin();
+         iter != protobuf_non_framework_imports_.end(); ++iter) {
+      printer->Print(
+          " #import \"$header$\"\n",
+          "header", *iter);
+    }
+    printer->Print(
+        "#endif\n");
+
+    if (other_imports_.size() > 0) {
+      printer->Print("\n");
+    }
+  }
+
+  if (other_imports_.size() > 0) {
+    for (vector<string>::const_iterator iter = other_imports_.begin();
+         iter != other_imports_.end(); ++iter) {
+      printer->Print(
+          " #import \"$header$\"\n",
+          "header", *iter);
+    }
+  }
+}
+
+}  // namespace
+
+
 FileGenerator::FileGenerator(const FileDescriptor *file, const Options& options)
     : file_(file),
       root_class_name_(FileClassName(file)),
@@ -82,15 +156,7 @@ FileGenerator::~FileGenerator() {
 }
 
 void FileGenerator::GenerateHeader(io::Printer *printer) {
-  printer->Print(
+  PrintFilePreamble(printer, "GPBProtocolBuffers.h");
-      "// Generated by the protocol buffer compiler.  DO NOT EDIT!\n"
-      "// source: $filename$\n"
-      "\n",
-      "filename", file_->name());
-
-  printer->Print(
-      "#import \"GPBProtocolBuffers.h\"\n"
-      "\n");
 
   // Add some verification that the generated code matches the source the
   // code is being compiled with.
@@ -102,14 +168,18 @@ void FileGenerator::GenerateHeader(io::Printer *printer) {
       "protoc_gen_objc_version",
       SimpleItoa(GOOGLE_PROTOBUF_OBJC_GEN_VERSION));
 
-  const vector<FileGenerator *> &dependency_generators = DependencyGenerators();
+  // #import any headers for "public imports" in the proto file.
-  for (vector<FileGenerator *>::const_iterator iter =
+  {
-           dependency_generators.begin();
+    ImportWriter import_writer;
-       iter != dependency_generators.end(); ++iter) {
+    const vector<FileGenerator *> &dependency_generators = DependencyGenerators();
-    if ((*iter)->IsPublicDependency()) {
+    for (vector<FileGenerator *>::const_iterator iter =
-      printer->Print("#import \"$header$.pbobjc.h\"\n",
+             dependency_generators.begin();
-                     "header", (*iter)->Path());
+         iter != dependency_generators.end(); ++iter) {
+      if ((*iter)->IsPublicDependency()) {
+        import_writer.AddFile(*iter);
+      }
     }
+    import_writer.Print(printer);
   }
 
   printer->Print(
@@ -198,27 +268,30 @@ void FileGenerator::GenerateHeader(io::Printer *printer) {
 }
 
 void FileGenerator::GenerateSource(io::Printer *printer) {
-  printer->Print(
+  // #import the runtime support.
-      "// Generated by the protocol buffer compiler.  DO NOT EDIT!\n"
+  PrintFilePreamble(printer, "GPBProtocolBuffers_RuntimeSupport.h");
-      "// source: $filename$\n"
-      "\n",
-      "filename", file_->name());
 
-  string header_file = Path() + ".pbobjc.h";
+  {
-  printer->Print(
+    ImportWriter import_writer;
-      "#import \"GPBProtocolBuffers_RuntimeSupport.h\"\n"
+
-      "#import \"$header_file$\"\n",
+    // #import the header for this proto file.
-      "header_file", header_file);
+    import_writer.AddFile(this);
-  const vector<FileGenerator *> &dependency_generators =
+
-      DependencyGenerators();
+    // #import the headers for anything that a plain dependency of this proto
-  for (vector<FileGenerator *>::const_iterator iter =
+    // file (that means they were just an include, not a "public" include).
-           dependency_generators.begin();
+    const vector<FileGenerator *> &dependency_generators =
-       iter != dependency_generators.end(); ++iter) {
+        DependencyGenerators();
-    if (!(*iter)->IsPublicDependency()) {
+    for (vector<FileGenerator *>::const_iterator iter =
-      printer->Print("#import \"$header$.pbobjc.h\"\n",
+             dependency_generators.begin();
-                     "header", (*iter)->Path());
+         iter != dependency_generators.end(); ++iter) {
+      if (!(*iter)->IsPublicDependency()) {
+        import_writer.AddFile(*iter);
+      }
     }
+
+    import_writer.Print(printer);
   }
+
   printer->Print(
       "// @@protoc_insertion_point(imports)\n"
       "\n"
@@ -356,8 +429,6 @@ void FileGenerator::GenerateSource(io::Printer *printer) {
     "// @@protoc_insertion_point(global_scope)\n");
 }
 
-const string FileGenerator::Path() const { return FilePath(file_); }
-
 const vector<FileGenerator *> &FileGenerator::DependencyGenerators() {
   if (file_->dependency_count() != dependency_generators_.size()) {
     set<string> public_import_names;
@@ -376,6 +447,34 @@ const vector<FileGenerator *> &FileGenerator::DependencyGenerators() {
   return dependency_generators_;
 }
 
+void FileGenerator::PrintFilePreamble(
+    io::Printer* printer, const string& header_to_import) const {
+  printer->Print(
+      "// Generated by the protocol buffer compiler.  DO NOT EDIT!\n"
+      "// source: $filename$\n"
+      "\n",
+      "filename", file_->name());
+
+  const string framework_name(ProtobufLibraryFrameworkName);
+  const string cpp_symbol(ProtobufFrameworkImportSymbol(framework_name));
+  printer->Print(
+      "// This CPP symbol can be defined to use imports that match up to the framework\n"
+      "// imports needed when using CocoaPods.\n"
+      "#if !defined($cpp_symbol$)\n"
+      " #define $cpp_symbol$ 0\n"
+      "#endif\n"
+      "\n"
+      "#if $cpp_symbol$\n"
+      " #import <$framework_name$/$header$>\n"
+      "#else\n"
+      " #import \"$header$\"\n"
+      "#endif\n"
+      "\n",
+      "cpp_symbol", cpp_symbol,
+      "header", header_to_import,
+      "framework_name", framework_name);
+}
+
 }  // namespace objectivec
 }  // namespace compiler
 }  // namespace protobuf

src/google/protobuf/compiler/objectivec/objectivec_file.h

@@ -62,7 +62,8 @@ class FileGenerator {
   void GenerateHeader(io::Printer* printer);
 
   const string& RootClassName() const { return root_class_name_; }
-  const string Path() const;
+  const string Path() const { return FilePath(file_); }
+  const FileDescriptor* Descriptor() const { return file_; }
 
   bool IsPublicDependency() const { return is_public_dep_; }
 
@@ -87,6 +88,8 @@ class FileGenerator {
   const Options options_;
 
   const vector<FileGenerator*>& DependencyGenerators();
+  void PrintFilePreamble(
+      io::Printer* printer, const string& header_to_import) const;
 
   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FileGenerator);
 };

src/google/protobuf/compiler/objectivec/objectivec_helpers.cc

@@ -293,13 +293,6 @@ string BaseFileName(const FileDescriptor* file) {
   return basename;
 }
 
-string FileName(const FileDescriptor* file) {
-  string path = FilePath(file);
-  string basename;
-  PathSplit(path, NULL, &basename);
-  return basename;
-}
-
 string FilePath(const FileDescriptor* file) {
   string output;
   string basename;
@@ -317,6 +310,19 @@ string FilePath(const FileDescriptor* file) {
   return output;
 }
 
+string FilePathBasename(const FileDescriptor* file) {
+  string output;
+  string basename;
+  string directory;
+  PathSplit(file->name(), &directory, &basename);
+  basename = StripProto(basename);
+
+  // CamelCase to be more ObjC friendly.
+  output = UnderscoresToCamelCase(basename, true);
+
+  return output;
+}
+
 string FileClassPrefix(const FileDescriptor* file) {
   // Default is empty string, no need to check has_objc_class_prefix.
   string result = file->options().objc_class_prefix();
@@ -831,6 +837,40 @@ string BuildCommentsString(const SourceLocation& location) {
   return final_comments;
 }
 
+// Making these a generator option for folks that don't use CocoaPods, but do
+// want to put the library in a framework is an interesting question. The
+// problem is it means changing sources shipped with the library to actually
+// use a different value; so it isn't as simple as a option.
+const char* const ProtobufLibraryFrameworkName = "Protobuf";
+
+string ProtobufFrameworkImportSymbol(const string& framework_name) {
+  // GPB_USE_[framework_name]_FRAMEWORK_IMPORTS
+  string result = string("GPB_USE_");
+  result += ToUpper(framework_name);
+  result += "_FRAMEWORK_IMPORTS";
+  return result;
+}
+
+bool IsProtobufLibraryBundledProtoFile(const FileDescriptor* file) {
+  // We don't check the name prefix or proto package because some files
+  // (descriptor.proto), aren't shipped generated by the library, so this
+  // seems to be the safest way to only catch the ones shipped.
+  const string name = file->name();
+  if (name == "google/protobuf/any.proto" ||
+      name == "google/protobuf/api.proto" ||
+      name == "google/protobuf/duration.proto" ||
+      name == "google/protobuf/empty.proto" ||
+      name == "google/protobuf/field_mask.proto" ||
+      name == "google/protobuf/source_context.proto" ||
+      name == "google/protobuf/struct.proto" ||
+      name == "google/protobuf/timestamp.proto" ||
+      name == "google/protobuf/type.proto" ||
+      name == "google/protobuf/wrappers.proto") {
+    return true;
+  }
+  return false;
+}
+
 namespace {
 
 // Internal helper class that parses the expected package to prefix mappings

src/google/protobuf/compiler/objectivec/objectivec_helpers.h

@@ -62,15 +62,14 @@ bool IsRetainedName(const string& name);
 // handling under ARC.
 bool IsInitName(const string& name);
 
-// Gets the name of the file we're going to generate (sans the .pb.h
-// extension).  This does not include the path to that file.
-string FileName(const FileDescriptor* file);
-
 // Gets the path of the file we're going to generate (sans the .pb.h
 // extension).  The path will be dependent on the objectivec package
 // declared in the proto package.
 string FilePath(const FileDescriptor* file);
 
+// Just like FilePath(), but without the directory part.
+string FilePathBasename(const FileDescriptor* file);
+
 // Gets the name of the root class we'll generate in the file.  This class
 // is not meant for external consumption, but instead contains helpers that
 // the rest of the classes need
@@ -169,6 +168,16 @@ string BuildFlagsString(const vector<string>& strings);
 // Builds a HeaderDoc style comment out of the comments in the .proto file.
 string BuildCommentsString(const SourceLocation& location);
 
+// The name the commonly used by the library when built as a framework.
+// This lines up to the name used in the CocoaPod.
+extern const char* const ProtobufLibraryFrameworkName;
+// Returns the CPP symbol name to use as the gate for framework style imports
+// for the given framework name to use.
+string ProtobufFrameworkImportSymbol(const string& framework_name);
+
+// Checks if the file is one of the proto's bundled with the library.
+bool IsProtobufLibraryBundledProtoFile(const FileDescriptor* file);
+
 // Checks the prefix for a given file and outputs any warnings needed, if
 // there are flat out errors, then out_error is filled in and the result is
 // false.