mirror of
https://github.com/google/sandboxed-api.git
synced 2024-03-22 13:11:30 +08:00
1ae04ac332
When generating headers from libraries that export functions as `extern "C"`
but still use namespaces (C-compatible C++ libraries), we want to generate
a Sandboxed API that includes fully-qualified namespace names as well.
In addition, we want the generated API to have the same source order as the
original library. Not only is this less surprising when reading the generated
code, it's also more accurate. Previously, we'd bundle all definitions in a
namespace and sort those alphabetically, but for code that relies on symbols
from another namespace to be available, generation will fail:
```c++
namespace zzz {
using entity_count_t = uint64_t;
} // namespace zzz
namespace sheep_counter {
using sheep_count_t = :💤:entity_count_t;
extern "C" void IncreaseSheepCounter(sheep_count_t increment);
} // namespace sheep_counter
```
PiperOrigin-RevId: 486586024
Change-Id: I419c9db8e9cb5b904364b353e2dc3d7f1030fab3
108 lines
3.8 KiB
C++
108 lines
3.8 KiB
C++
// Copyright 2020 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#ifndef SANDBOXED_API_TOOLS_CLANG_GENERATOR_EMITTER_H_
|
|
#define SANDBOXED_API_TOOLS_CLANG_GENERATOR_EMITTER_H_
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "absl/container/flat_hash_set.h"
|
|
#include "absl/container/node_hash_set.h"
|
|
#include "absl/status/status.h"
|
|
#include "absl/status/statusor.h"
|
|
#include "absl/strings/string_view.h"
|
|
#include "clang/AST/Decl.h"
|
|
#include "clang/AST/Type.h"
|
|
#include "sandboxed_api/tools/clang_generator/types.h"
|
|
|
|
namespace sapi {
|
|
namespace internal {
|
|
|
|
absl::StatusOr<std::string> ReformatGoogleStyle(const std::string& filename,
|
|
const std::string& code,
|
|
int column_limit = -1);
|
|
|
|
} // namespace internal
|
|
|
|
class GeneratorOptions;
|
|
|
|
class RenderedType {
|
|
public:
|
|
RenderedType(std::string ns_name, std::string spelling)
|
|
: ns_name(std::move(ns_name)), spelling(std::move(spelling)) {}
|
|
|
|
bool operator==(const RenderedType& other) const {
|
|
return ns_name == other.ns_name && spelling == other.spelling;
|
|
}
|
|
|
|
template <typename H>
|
|
friend H AbslHashValue(H h, RenderedType rt) {
|
|
return H::combine(std::move(h), rt.ns_name, rt.spelling);
|
|
}
|
|
|
|
std::string ns_name;
|
|
std::string spelling;
|
|
};
|
|
|
|
// Responsible for emitting the actual textual representation of the generated
|
|
// Sandboxed API header.
|
|
class Emitter {
|
|
public:
|
|
// Adds the set of previously collected types to the emitter, recording the
|
|
// spelling of each one. Types that are not supported by the current
|
|
// generator settings or that are unwanted/unnecessary are skipped. Filtered
|
|
// types include C++ constructs or well-known standard library elements. The
|
|
// latter can be replaced by including the correct headers in the emitted
|
|
// header.
|
|
void AddTypesFiltered(const QualTypeSet& types);
|
|
|
|
absl::Status AddFunction(clang::FunctionDecl* decl);
|
|
|
|
// Outputs a formatted header for a list of functions and their related types.
|
|
absl::StatusOr<std::string> EmitHeader(const GeneratorOptions& options);
|
|
|
|
private:
|
|
void EmitType(clang::QualType qual);
|
|
|
|
protected:
|
|
// Stores namespaces and a list of spellings for types. Keeps track of types
|
|
// that have been rendered so far. Using a node_hash_set for pointer
|
|
// stability.
|
|
absl::node_hash_set<RenderedType> rendered_types_;
|
|
|
|
// A vector to preserve the order of type declarations needs to be preserved.
|
|
std::vector<const RenderedType*> rendered_types_ordered_;
|
|
|
|
// Fully qualified names of functions for the sandboxed API. Keeps track of
|
|
// functions that have been rendered so far.
|
|
absl::flat_hash_set<std::string> rendered_functions_;
|
|
|
|
// Rendered function bodies, as a vector to preserve source order. This is
|
|
// not strictly necessary, but makes the output look less surprising.
|
|
std::vector<std::string> rendered_functions_ordered_;
|
|
};
|
|
|
|
// Constructs an include guard name for the given filename. The name is of the
|
|
// same form as the include guards in this project and conforms to the Google
|
|
// C++ style. For example,
|
|
// sandboxed_api/examples/zlib/zlib-sapi.sapi.h
|
|
// will be mapped to
|
|
// SANDBOXED_API_EXAMPLES_ZLIB_ZLIB_SAPI_SAPI_H_
|
|
std::string GetIncludeGuard(absl::string_view filename);
|
|
|
|
} // namespace sapi
|
|
|
|
#endif // SANDBOXED_API_TOOLS_CLANG_GENERATOR_EMITTER_H_
|