mirror of
https://github.com/google/sandboxed-api.git
synced 2024-03-22 13:11:30 +08:00
67bc67bbef
This change changes the emitter to work on `clang::TypeDecl`s instead of `clang::QualType`s, as the latter only describe complete definitions. This allows us to better deal with situations where we would otherwise have a kind of circular type dependencies: For example, a `typedef` that depends on a `struct` which in turn has a member that references the typedef. For this to work, we now also record the actual source order of declarations, similar to what the libclang based header generator does. Also add some more tests for the newly covered cases. PiperOrigin-RevId: 488370914 Change-Id: I2d1baa863fb12d1801bf11a20f3f88df7fde3129
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 declarations of previously collected types to the emitter,
|
|
// recording the spelling of each one. Types/declarations that are not
|
|
// supported by the current generator settings or that are unwanted or
|
|
// unnecessary are skipped. Other 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 AddTypeDeclarations(const std::vector<clang::TypeDecl*>& type_decls);
|
|
|
|
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::TypeDecl* type_decl);
|
|
|
|
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_
|