This does not help the attached bugs, but it does allow greater control over what JSON code is running where. Long-term, the JSON library used for parsing configuration should likely be a library already present in Chromium builds, to avoid duplication. And if that happens, then WebRTC bug 9804 may be passé. Note that this CL also sorts our poisons alphabetically. Bug: chromium:895814, webrtc:9804 Change-Id: I70c3efe05a0eba9212895407f73978d8216df920 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/158400 Reviewed-by: Karl Wiberg <kwiberg@webrtc.org> Commit-Queue: Sam Zackrisson <saza@webrtc.org> Cr-Commit-Position: refs/heads/master@{#29615}
How to write code in the api/ directory
Mostly, just follow the regular style guide, but:
- Note that
api/code is not exempt from the “.hand.ccfiles come in pairs” rule, so if you declare something inapi/path/to/foo.h, it should be defined inapi/path/to/foo.cc. - Headers in
api/should, if possible, not#includeheaders outsideapi/. It’s not always possible to avoid this, but be aware that it adds to a small mountain of technical debt that we’re trying to shrink. .ccfiles inapi/, on the other hand, are free to#includeheaders outsideapi/.
That is, the preferred way for api/ code to access non-api/ code is to call
it from a .cc file, so that users of our API headers won’t transitively
#include non-public headers.
For headers in api/ that need to refer to non-public types, forward
declarations are often a lesser evil than including non-public header files. The
usual rules still apply, though.
.cc files in api/ should preferably be kept reasonably small. If a
substantial implementation is needed, consider putting it with our non-public
code, and just call it from the api/ .cc file.