sandboxed-api/sandboxed_api/tools/clang_generator/types.h
Christian Blichmann 67bc67bbef clang_generator: Handle inter-type dependencies better
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
2022-11-14 08:19:13 -08:00

102 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_TYPES_H_
#define SANDBOXED_API_TOOLS_CLANG_GENERATOR_TYPES_H_
#include <string>
#include <vector>
#include "absl/container/flat_hash_set.h"
#include "clang/AST/ASTContext.h"
#include "clang/AST/Decl.h"
#include "clang/AST/Type.h"
#include "llvm/ADT/SetVector.h"
#include "llvm/ADT/SmallPtrSet.h"
namespace sapi {
using QualTypeSet =
llvm::SetVector<clang::QualType, std::vector<clang::QualType>,
llvm::SmallPtrSet<clang::QualType, 8>>;
// Returns whether a type is "simple". Simple types are arithmetic types,
// i.e. signed and unsigned integer, character and bool types, as well as
// "void".
inline bool IsSimple(clang::QualType qual) {
return qual->isArithmeticType() || qual->isVoidType();
}
inline bool IsPointerOrReference(clang::QualType qual) {
return qual->isAnyPointerType() || qual->isReferenceType();
}
class TypeCollector {
public:
// Records the source order of the given type in the current translation unit.
// This is different from collecting related types, as the emitter also needs
// to know in which order to emit typedefs vs forward decls, etc. and
// QualTypes only refer to complete definitions.
void RecordOrderedDecl(clang::TypeDecl* type_decl);
// Computes the transitive closure of all types that a type depends on. Those
// are types that need to be declared before a declaration of the type denoted
// by the qual parameter is valid. For example, given
// struct SubStruct { bool truth_value; };
// struct AggregateStruct {
// int int_member;
// SubStruct struct_member;
// };
//
// calling this function on the type "AggregateStruct" yields these types:
// int
// bool
// SubStruct
void CollectRelatedTypes(clang::QualType qual);
// Returns the declarations for the collected types in source order.
std::vector<clang::TypeDecl*> GetTypeDeclarations();
private:
std::vector<clang::TypeDecl*> ordered_decls_;
QualTypeSet collected_;
QualTypeSet seen_;
};
// Maps a qualified type to a fully qualified SAPI-compatible type name. This
// is used for the generated code that invokes the actual function call IPC.
// If no mapping can be found, "int" is assumed.
std::string MapQualType(const clang::ASTContext& context, clang::QualType qual);
// Maps a qualified type to a fully qualified C++ type name. Transforms C-only
// constructs such as _Bool to bool.
std::string MapQualTypeParameterForCxx(const clang::ASTContext& context,
clang::QualType qual);
// Maps a qualified type used as a function parameter to a type name compatible
// with the generated Sandboxed API.
std::string MapQualTypeParameter(const clang::ASTContext& context,
clang::QualType qual);
// Maps a qualified type used as a function return type to a type name
// compatible with the generated Sandboxed API. Uses MapQualTypeParameter() and
// wraps the type in an "absl::StatusOr<>" if qual is non-void. Otherwise
// returns "absl::Status".
std::string MapQualTypeReturn(const clang::ASTContext& context,
clang::QualType qual);
} // namespace sapi
#endif // SANDBOXED_API_TOOLS_CLANG_GENERATOR_TYPES_H_