object-introspection/oi/type_graph/Printer.h
Jake Hillion 55989a9156 oilgen: migrate to source parsing (#421)
Summary:
oilgen: migrate to source parsing

Using debug information generated from partial source (that is, not the final
binary) has been insufficient to generally generate OIL code.

A particular example is pointers to templates:
```cpp
#include <oi/oi.h>
template <typename T>
struct Foo {
  T t;
};
template <typename T>
struct Bar {
  Foo<T>& f;
};
void foo(const Bar<int>& b) {
  oi::introspect(b);
}
```

The pointer/reference to `Foo<int>` appears in DWARF with
`DW_AT_declaration(true)` because it could be specialised before its usage.
However, with OIL, we are creating an implicit usage site in the
`oi::introspect` call that the compiler is unable to see.

This change reworks OILGen to work from a Clang command line rather than debug
information. We setup and run a compiler on the source, giving us access to an
AST and Semantic Analyser. We then:
- Find the `oi::introspect` template.
- Iterate through each of its callsites for their type.
- Run `ClangTypeParser::parse` on each type.
- Run codegen.
- Compile into an object file.

Having access to the semantic analyser allows us to forcefully complete a type,
as it would be if it was used in the initial code.


Test Plan:
hope

`buck2 run fbcode//mode/opt fbcode//object-introspection/oil/examples/compile-time:compile-time`

Reviewed By: tyroguru

Differential Revision: D51854477

Pulled By: JakeHillion
2023-12-19 13:26:25 -08:00

68 lines
2.0 KiB
C++

/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* 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
*
* http://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.
*/
#pragma once
#include <ostream>
#include "NodeTracker.h"
#include "Types.h"
#include "Visitor.h"
namespace oi::detail::type_graph {
/*
* Printer
*/
class Printer : public ConstVisitor {
public:
Printer(std::ostream& out, NodeTracker& tracker, size_t numTypes);
void print(const Type& type);
void visit(const Incomplete& i) override;
void visit(const Class& c) override;
void visit(const Container& c) override;
void visit(const Primitive& p) override;
void visit(const Enum& e) override;
void visit(const Array& a) override;
void visit(const Typedef& td) override;
void visit(const Pointer& p) override;
void visit(const Reference& r) override;
void visit(const Dummy& d) override;
void visit(const DummyAllocator& d) override;
void visit(const CaptureKeys& d) override;
private:
void prefix();
[[nodiscard]] bool prefix(const Type& type);
void print_param(const TemplateParam& param);
void print_parent(const Parent& parent);
void print_member(const Member& member);
void print_function(const Function& function);
void print_type(std::string_view header, const Type& type);
void print_value(const std::string& value);
void print_qualifiers(const QualifierSet& qualifiers);
void print_enumerator(int64_t val, const std::string& name);
static std::string align_str(uint64_t align);
NodeTracker& tracker_;
std::ostream& out_;
int baseIndent_;
int depth_ = -1;
};
} // namespace oi::detail::type_graph