blob: a767a612a617dba65949d41bfa448496b1495192 [file] [log] [blame]
Jorge Canizalese487a722016-04-30 12:05:26 -07001%YAML 1.2
2--- |
Muxi Yan27e9db42017-01-30 09:21:05 -08003 # This file has been automatically generated from a template file.
4 # Please make modifications to `templates/gRPC-Core.podspec.template`
5 # instead. This file can be regenerated from the template by running
6 # `tools/buildgen/generate_projects.sh`.
Jorge Canizalese487a722016-04-30 12:05:26 -07007
Muxi Yan27e9db42017-01-30 09:21:05 -08008 # gRPC Core CocoaPods podspec
9 #
Jan Tattermusch4d5c3102017-06-07 10:23:56 +020010 # Copyright 2015 gRPC authors.
Jorge Canizalese487a722016-04-30 12:05:26 -070011 #
Jan Tattermusch4d5c3102017-06-07 10:23:56 +020012 # Licensed under the Apache License, Version 2.0 (the "License");
13 # you may not use this file except in compliance with the License.
14 # You may obtain a copy of the License at
Jorge Canizalese487a722016-04-30 12:05:26 -070015 #
Jan Tattermusch4d5c3102017-06-07 10:23:56 +020016 # http://www.apache.org/licenses/LICENSE-2.0
Jorge Canizalese487a722016-04-30 12:05:26 -070017 #
Jan Tattermusch4d5c3102017-06-07 10:23:56 +020018 # Unless required by applicable law or agreed to in writing, software
19 # distributed under the License is distributed on an "AS IS" BASIS,
20 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 # See the License for the specific language governing permissions and
22 # limitations under the License.
Jorge Canizalese487a722016-04-30 12:05:26 -070023
24 <%!
Muxi Yanb0f821c2017-12-19 15:37:57 -080025 def grpc_lib_files(libs, expect_libs, groups):
Jorge Canizalese487a722016-04-30 12:05:26 -070026 out = []
27 for lib in libs:
Muxi Yanb0f821c2017-12-19 15:37:57 -080028 if lib.name in expect_libs:
29 for group in groups:
30 out += lib.get(group, [])
31 return out
32
33 def grpc_private_files(libs):
34 out = grpc_lib_files(libs, ("grpc", "gpr"), ("headers", "src"))
35 return [file for file in out if not file.startswith("third_party/nanopb/")]
Jorge Canizalescc074d92016-06-28 09:52:43 -070036
37 def grpc_public_headers(libs):
Muxi Yanb0f821c2017-12-19 15:37:57 -080038 out = grpc_lib_files(libs, ("grpc", "gpr"), ("public_headers",))
Muxi Yancd972972017-10-06 13:46:27 -070039 return out
Jorge Canizalescc074d92016-06-28 09:52:43 -070040
Jorge Canizalese487a722016-04-30 12:05:26 -070041 def grpc_private_headers(libs):
Muxi Yanb0f821c2017-12-19 15:37:57 -080042 out = grpc_lib_files(libs, ("grpc", "gpr"), ("headers",))
43 return [file for file in out if not file.startswith("third_party/nanopb/")]
44
Muxi Yan834aeca2018-03-30 16:02:23 -070045 def grpc_cronet_files(libs):
46 out = grpc_lib_files(libs, ("grpc_cronet",), ("src", "headers"))
47 excl = grpc_private_files(libs)
48 excl += [
49 # We do not need cronet dedicated plugin registry
50 "src/core/plugin_registry/grpc_cronet_plugin_registry.cc",
51 # We do not need dummy cronet API for ObjC
Muxi Yanb0f821c2017-12-19 15:37:57 -080052 "src/core/ext/transport/cronet/transport/cronet_api_dummy.cc",
53 ]
54 return [file for file in out if not file in excl]
55
56 def grpc_cronet_public_headers(libs):
Muxi Yan834aeca2018-03-30 16:02:23 -070057 out = grpc_lib_files(libs, ("grpc_cronet",), ("public_headers",))
58 excl = grpc_public_headers(libs)
59 return [file for file in out if not file in excl]
Muxi Yanb0f821c2017-12-19 15:37:57 -080060
61 def grpc_test_util_files(libs):
62 out = grpc_lib_files(libs, ("grpc_test_util", "gpr_test_util"), ("src", "headers"))
63 excl = grpc_private_files(libs)
64 return [file for file in out if not file in excl]
65
66 def end2end_tests_files(libs):
67 out = grpc_lib_files(libs, ("end2end_tests",), ("src", "headers"))
68 excl = grpc_private_files(libs)
69 return [file for file in out if not file in excl]
Jorge Canizalescc074d92016-06-28 09:52:43 -070070
Muxi Yanc512b4f2018-06-05 09:42:33 -070071 def cfstream_private_headers(libs):
72 out = grpc_lib_files(libs, ("grpc_cfstream",), ("own_headers",))
73 return out
74
75 def cfstream_private_files(libs):
76 out = grpc_lib_files(libs, ("grpc_cfstream",), ("own_src", "own_headers"))
77 return out
78
Jorge Canizalescc074d92016-06-28 09:52:43 -070079 def ruby_multiline_list(files, indent):
80 return (',\n' + indent*' ').join('\'%s\'' % f for f in files)
Jorge Canizalese487a722016-04-30 12:05:26 -070081 %>
82 Pod::Spec.new do |s|
83 s.name = 'gRPC-Core'
Muxi Yan690aee62017-01-27 02:52:47 +000084 version = '${settings.version}'
Jorge Canizalese487a722016-04-30 12:05:26 -070085 s.version = version
86 s.summary = 'Core cross-platform gRPC library, written in C'
Mehrdad Afsharibb3d95b2017-07-10 22:24:28 +000087 s.homepage = 'https://grpc.io'
Jan Tattermusch4d5c3102017-06-07 10:23:56 +020088 s.license = 'Apache License, Version 2.0'
Jorge Canizalese487a722016-04-30 12:05:26 -070089 s.authors = { 'The gRPC contributors' => 'grpc-packages@google.com' }
90
91 s.source = {
92 :git => 'https://github.com/grpc/grpc.git',
Muxi Yan690aee62017-01-27 02:52:47 +000093 :tag => "v#{version}",
Jorge Canizalese487a722016-04-30 12:05:26 -070094 }
95
Muxi Yan3d2081b2017-10-31 10:27:46 -070096 # gRPC podspecs depend on fix for https://github.com/CocoaPods/CocoaPods/issues/6024,
97 # which was released in Cocoapods v1.2.0.
98 s.cocoapods_version = '>= 1.2.0'
99
Muxi Yan37d3fba2017-02-28 16:14:40 -0800100 s.ios.deployment_target = '7.0'
Jorge Canizalese487a722016-04-30 12:05:26 -0700101 s.osx.deployment_target = '10.9'
102 s.requires_arc = false
103
104 name = 'grpc'
Jorge Canizalese487a722016-04-30 12:05:26 -0700105
Jorge Canizalescc074d92016-06-28 09:52:43 -0700106 # When creating a dynamic framework, name it grpc.framework instead of gRPC-Core.framework.
107 # This lets users write their includes like `#include <grpc/grpc.h>` as opposed to `#include
108 # <gRPC-Core/grpc.h>`.
109 s.module_name = name
110
111 # When creating a dynamic framework, copy the headers under `include/grpc/` into the root of
112 # the `Headers/` directory of the framework (i.e., not under `Headers/include/grpc`).
113 #
114 # TODO(jcanizales): Debug why this doesn't work on macOS.
Jorge Canizalese487a722016-04-30 12:05:26 -0700115 s.header_mappings_dir = 'include/grpc'
116
Jorge Canizalescc074d92016-06-28 09:52:43 -0700117 # The above has an undesired effect when creating a static library: It forces users to write
118 # includes like `#include <gRPC-Core/grpc.h>`. `s.header_dir` adds a path prefix to that, and
119 # because Cocoapods lets omit the pod name when including headers of static libraries, the
120 # following lets users write `#include <grpc/grpc.h>`.
121 s.header_dir = name
Jorge Canizalese487a722016-04-30 12:05:26 -0700122
Jorge Canizalescc074d92016-06-28 09:52:43 -0700123 # The module map created automatically by Cocoapods doesn't work for C libraries like gRPC-Core.
Jorge Canizales37750742016-06-08 20:10:20 -0700124 s.module_map = 'include/grpc/module.modulemap'
125
Jorge Canizalescc074d92016-06-28 09:52:43 -0700126 # To compile the library, we need the user headers search path (quoted includes) to point to the
127 # root of the repo, and the system headers search path (angled includes) to point to `include/`.
128 # Cocoapods effectively clones the repo under `<Podfile dir>/Pods/gRPC-Core/`, and sets a build
129 # variable called `$(PODS_ROOT)` to `<Podfile dir>/Pods/`, so we use that.
130 #
131 # Relying on the file structure under $(PODS_ROOT) isn't officially supported in Cocoapods, as it
132 # is taken as an implementation detail. We've asked for an alternative, and have been told that
133 # what we're doing should keep working: https://github.com/CocoaPods/CocoaPods/issues/4386
134 #
135 # The `src_root` value of `$(PODS_ROOT)/gRPC-Core` assumes Cocoapods is installing this pod from
136 # its remote repo. For local development of this library, enabled by using `:path` in the Podfile,
137 # that assumption is wrong. In such case, the following settings need to be reset with the
138 # appropriate value of `src_root`. This can be accomplished in the `pre_install` hook of the
139 # Podfile; see `src/objective-c/tests/Podfile` for an example.
140 src_root = '$(PODS_ROOT)/gRPC-Core'
141 s.pod_target_xcconfig = {
142 'GRPC_SRC_ROOT' => src_root,
143 'HEADER_SEARCH_PATHS' => '"$(inherited)" "$(GRPC_SRC_ROOT)/include"',
144 'USER_HEADER_SEARCH_PATHS' => '"$(GRPC_SRC_ROOT)"',
145 # If we don't set these two settings, `include/grpc/support/time.h` and
Mark D. Rothdbdf4952018-01-18 11:21:12 -0800146 # `src/core/lib/gpr/string.h` shadow the system `<time.h>` and `<string.h>`, breaking the
Jorge Canizalescc074d92016-06-28 09:52:43 -0700147 # build.
148 'USE_HEADERMAP' => 'NO',
149 'ALWAYS_SEARCH_USER_PATHS' => 'NO',
Muxi Yan9ecc2152017-09-29 17:08:59 -0700150 'GCC_PREPROCESSOR_DEFINITIONS' => '"$(inherited)" "COCOAPODS=1" "PB_NO_PACKED_STRUCTS=1"',
Muxi Yan94d669e2017-10-22 14:56:10 -0700151 'CLANG_WARN_STRICT_PROTOTYPES' => 'NO',
Jorge Canizalescc074d92016-06-28 09:52:43 -0700152 }
Jorge Canizales37750742016-06-08 20:10:20 -0700153
Muxi Yan37480eb2016-07-14 16:22:03 -0700154 s.default_subspecs = 'Interface', 'Implementation'
Yihua Zhang04fb58e2018-03-08 06:49:24 -0800155 s.compiler_flags = '-DGRPC_ARES=0', '-DPB_FIELD_16BIT'
Muxi Yanae6bca42017-10-19 18:14:02 -0700156 s.libraries = 'c++'
Muxi Yan37480eb2016-07-14 16:22:03 -0700157
Jorge Canizalescc074d92016-06-28 09:52:43 -0700158 # Like many other C libraries, gRPC-Core has its public headers under `include/<libname>/` and its
159 # sources and private headers in other directories outside `include/`. Cocoapods' linter doesn't
160 # allow any header to be listed outside the `header_mappings_dir` (even though doing so works in
161 # practice). Because we need our `header_mappings_dir` to be `include/grpc/` for the reason
162 # mentioned above, we work around the linter limitation by dividing the pod into two subspecs, one
163 # for public headers and the other for implementation. Each gets its own `header_mappings_dir`,
164 # making the linter happy.
165 #
166 # The list of source files is generated by a template: `templates/gRPC-Core.podspec.template`. It
167 # can be regenerated from the template by running `tools/buildgen/generate_projects.sh`.
168 s.subspec 'Interface' do |ss|
169 ss.header_mappings_dir = 'include/grpc'
170
171 ss.source_files = ${ruby_multiline_list(grpc_public_headers(libs), 22)}
172 end
173 s.subspec 'Implementation' do |ss|
174 ss.header_mappings_dir = '.'
175 ss.libraries = 'z'
176 ss.dependency "#{s.name}/Interface", version
Matt Kwong74958c52018-01-30 11:52:02 -0800177 ss.dependency 'BoringSSL', '~> 10.0'
Muxi Yanad272c92017-06-29 16:18:43 -0700178 ss.dependency 'nanopb', '~> 0.3'
Jorge Canizalescc074d92016-06-28 09:52:43 -0700179
Muxi Yan834aeca2018-03-30 16:02:23 -0700180 # To save you from scrolling, this is the last part of the podspec.
Jorge Canizalescc074d92016-06-28 09:52:43 -0700181 ss.source_files = ${ruby_multiline_list(grpc_private_files(libs), 22)}
182
183 ss.private_header_files = ${ruby_multiline_list(grpc_private_headers(libs), 30)}
184 end
Muxi Yan37480eb2016-07-14 16:22:03 -0700185
Muxi Yan67ff4052018-05-15 12:36:10 -0700186 s.subspec 'CFStream-Implementation' do |ss|
187 ss.header_mappings_dir = '.'
188 ss.dependency "#{s.name}/Implementation", version
189 ss.pod_target_xcconfig = {
190 'GCC_PREPROCESSOR_DEFINITIONS' => 'GRPC_CFSTREAM=1'
191 }
Muxi Yanc512b4f2018-06-05 09:42:33 -0700192 ss.source_files = ${ruby_multiline_list(cfstream_private_files(filegroups), 22)}
193 ss.private_header_files = ${ruby_multiline_list(cfstream_private_headers(filegroups), 30)}
Muxi Yan67ff4052018-05-15 12:36:10 -0700194 end
195
Muxi Yan37480eb2016-07-14 16:22:03 -0700196 s.subspec 'Cronet-Interface' do |ss|
197 ss.header_mappings_dir = 'include/grpc'
Muxi Yanb0f821c2017-12-19 15:37:57 -0800198 ss.source_files = ${ruby_multiline_list(grpc_cronet_public_headers(libs), 22)}
Muxi Yan37480eb2016-07-14 16:22:03 -0700199 end
200
Muxi Yanf8372c62016-07-29 09:58:55 -0700201 s.subspec 'Cronet-Implementation' do |ss|
Muxi Yan2a5072e2016-07-27 15:10:22 -0700202 ss.header_mappings_dir = '.'
Muxi Yan834aeca2018-03-30 16:02:23 -0700203
204 ss.dependency "#{s.name}/Interface", version
205 ss.dependency "#{s.name}/Implementation", version
Muxi Yane2de92f2017-01-31 16:30:52 -0800206 ss.dependency "#{s.name}/Cronet-Interface", version
207
Muxi Yan834aeca2018-03-30 16:02:23 -0700208 ss.source_files = ${ruby_multiline_list(grpc_cronet_files(libs), 22)}
Muxi Yan2a5072e2016-07-27 15:10:22 -0700209 end
210
Muxi Yan834aeca2018-03-30 16:02:23 -0700211 s.subspec 'Tests' do |ss|
Muxi Yan37480eb2016-07-14 16:22:03 -0700212 ss.header_mappings_dir = '.'
213
Muxi Yan834aeca2018-03-30 16:02:23 -0700214 ss.dependency "#{s.name}/Interface", version
215 ss.dependency "#{s.name}/Implementation", version
Muxi Yane2de92f2017-01-31 16:30:52 -0800216
Muxi Yanb0f821c2017-12-19 15:37:57 -0800217 ss.source_files = ${ruby_multiline_list(grpc_test_util_files(libs), 22)},
218 ${ruby_multiline_list(end2end_tests_files(libs), 22)}
Muxi Yan37480eb2016-07-14 16:22:03 -0700219 end
Muxi Yan43c47102017-07-06 20:51:49 -0700220
221 # TODO (mxyan): Instead of this hack, add include path "third_party" to C core's include path?
222 s.prepare_command = <<-END_OF_COMMAND
Muxi Yan40beafa2018-03-08 15:36:33 -0800223 find src/core/ -type f ! -path '*.back*' -exec sed -E -i'.back' 's;#include "third_party/nanopb/(.*)";#include <nanopb/\\1>;g' {} \\\;
Muxi Yan43c47102017-07-06 20:51:49 -0700224 END_OF_COMMAND
Jorge Canizalese487a722016-04-30 12:05:26 -0700225 end