diff options
Diffstat (limited to 'tools/slang-cpp-extractor/cpp-extractor-main.cpp')
| -rw-r--r-- | tools/slang-cpp-extractor/cpp-extractor-main.cpp | 402 |
1 files changed, 0 insertions, 402 deletions
diff --git a/tools/slang-cpp-extractor/cpp-extractor-main.cpp b/tools/slang-cpp-extractor/cpp-extractor-main.cpp deleted file mode 100644 index bd7787162..000000000 --- a/tools/slang-cpp-extractor/cpp-extractor-main.cpp +++ /dev/null @@ -1,402 +0,0 @@ -// main.cpp - -#include "compiler-core/slang-diagnostic-sink.h" -#include "compiler-core/slang-doc-extractor.h" -#include "compiler-core/slang-lexer.h" -#include "compiler-core/slang-name-convention-util.h" -#include "compiler-core/slang-name.h" -#include "compiler-core/slang-source-loc.h" -#include "core/slang-file-system.h" -#include "core/slang-io.h" -#include "core/slang-list.h" -#include "core/slang-secure-crt.h" -#include "core/slang-string-slice-pool.h" -#include "core/slang-string-util.h" -#include "core/slang-string.h" -#include "core/slang-writer.h" -#include "macro-writer.h" -#include "slang-com-helper.h" -#include "slang-cpp-parser/diagnostics.h" -#include "slang-cpp-parser/file-util.h" -#include "slang-cpp-parser/node.h" -#include "slang-cpp-parser/options.h" -#include "slang-cpp-parser/parser.h" -#include "slang-cpp-parser/unit-test.h" - -#include <stdio.h> -#include <stdlib.h> -#include <string.h> - -/* -Some command lines: - --d source/slang slang-ast-support-types.h slang-ast-base.h slang-ast-decl.h slang-ast-expr.h -slang-ast-modifier.h slang-ast-stmt.h slang-ast-type.h slang-ast-val.h -strip-prefix slang- -o -slang-generated -output-fields -mark-suffix _CLASS -*/ - -namespace CppExtract -{ - -using namespace Slang; - -// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! App !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - -class App -{ -public: - SlangResult execute(const Options& options); - - /// Execute - SlangResult executeWithArgs(int argc, const char* const* argv); - - const Options& getOptions() const { return m_options; } - - App(DiagnosticSink* sink, SourceManager* sourceManager, RootNamePool* rootNamePool) - : m_sink(sink), m_sourceManager(sourceManager), m_slicePool(StringSlicePool::Style::Default) - { - m_namePool.setRootNamePool(rootNamePool); - } - -protected: - SlangResult _extractDoc(NodeTree* nodeTree); - - NamePool m_namePool; - - Options m_options; - DiagnosticSink* m_sink; - SourceManager* m_sourceManager; - - StringSlicePool m_slicePool; -}; - - -// Work out an appropriate search type for a node type. -// -// TODO(JS): -// NOTE! Currently extractor doesn't extract callable types and so doesn't extract callable types -// parameters -static DocMarkupExtractor::SearchStyle _getSearchStyle(Node* node) -{ - typedef DocMarkupExtractor::SearchStyle SearchStyle; - - if (!node->getSourceLoc().isValid()) - { - return SearchStyle::None; - } - - switch (node->m_kind) - { - case Node::Kind::Invalid: - { - return SearchStyle::None; - } - case Node::Kind::Field: - { - return SearchStyle::Variable; - } - case Node::Kind::EnumCase: - { - return SearchStyle::EnumCase; - } - case Node::Kind::TypeDef: - { - return SearchStyle::Variable; - } - case Node::Kind::Callable: - { - return SearchStyle::Before; - } - default: - break; - } - - // Default is to only allow before. - return SearchStyle::Before; -} - -SlangResult App::_extractDoc(NodeTree* nodeTree) -{ - // Find all of the nodes - List<Node*> nodes; - // Add the root - nodes.add(nodeTree->getRootNode()); - - // Traverse all nodes - for (Index startIndex = 0; startIndex < nodes.getCount(); ++startIndex) - { - Node* node = nodes[startIndex]; - - ScopeNode* scopeNode = as<ScopeNode>(node); - - if (scopeNode) - { - for (Node* child : scopeNode->m_children) - { - nodes.add(child); - } - } - } - - // Find out what to find - - List<DocMarkupExtractor::SearchItemInput> inputItems; - - for (Node* node : nodes) - { - auto searchStyle = _getSearchStyle(node); - - DocMarkupExtractor::SearchItemInput inputItem; - inputItem.searchStyle = searchStyle; - inputItem.sourceLoc = node->getSourceLoc(); - - inputItems.add(inputItem); - } - - List<DocMarkupExtractor::SearchItemOutput> outputItems; - - List<SourceView*> views; - - DocMarkupExtractor extractor; - - SLANG_RETURN_ON_FAIL(extractor.extract( - inputItems.getBuffer(), - inputItems.getCount(), - m_sourceManager, - m_sink, - views, - outputItems)); - - // Put what was extracted into the nodes - { - const Index count = inputItems.getCount(); - SLANG_ASSERT(count == outputItems.getCount() && count == nodes.getCount()); - - for (Index i = 0; i < count; ++i) - { - const auto& outputItem = outputItems[i]; - - // We need to use the index used for input, because in output they can be reordered. - const auto inputIndex = outputItem.inputIndex; - const auto& inputItem = inputItems[inputIndex]; - - if (inputItem.searchStyle != DocMarkupExtractor::SearchStyle::None && - outputItem.text.getLength()) - { - Node* node = nodes[inputIndex]; - - node->m_markup = outputItem.text; - node->m_markupVisibility = outputItem.visibilty; - } - } - } - - return SLANG_OK; -} - -SlangResult App::execute(const Options& options) -{ - m_options = options; - - if (options.m_runUnitTests) - { - SLANG_RETURN_ON_FAIL(UnitTestUtil::run()); - } - - IdentifierLookup identifierLookup; - identifierLookup.initDefault(options.m_markPrefix.getUnownedSlice()); - - NodeTree tree(&m_slicePool, &m_namePool, &identifierLookup); - - // Read in each of the input files - for (Index i = 0; i < m_options.m_inputPaths.getCount(); ++i) - { - String inputPath; - - if (m_options.m_inputDirectory.getLength()) - { - inputPath = Path::combine(m_options.m_inputDirectory, m_options.m_inputPaths[i]); - } - else - { - inputPath = m_options.m_inputPaths[i]; - } - - // Read the input file - String contents; - SLANG_RETURN_ON_FAIL(FileUtil::readAllText(inputPath, m_sink, contents)); - - PathInfo pathInfo = PathInfo::makeFromString(inputPath); - - SourceFile* sourceFile = m_sourceManager->createSourceFileWithString(pathInfo, contents); - - SourceOrigin* sourceOrigin = tree.addSourceOrigin(sourceFile, options); - - Parser parser(&tree, m_sink); - SLANG_RETURN_ON_FAIL(parser.parse(sourceOrigin, &m_options)); - } - - SLANG_RETURN_ON_FAIL(tree.calcDerivedTypes(m_sink)); - - // Okay let's check out the typeSets - { - for (TypeSet* typeSet : tree.getTypeSets()) - { - // The macro name is in upper snake, so split it - List<UnownedStringSlice> slices; - NameConventionUtil::split(typeSet->m_macroName, slices); - - if (typeSet->m_fileMark.getLength() == 0) - { - StringBuilder buf; - // Let's guess a 'fileMark' (it becomes part of the filename) based on the macro - // name. Use lower kabab. - NameConventionUtil::join( - slices.getBuffer(), - slices.getCount(), - NameConvention::LowerKabab, - buf); - typeSet->m_fileMark = buf.produceString(); - } - - if (typeSet->m_typeName.getLength() == 0) - { - // Let's guess a typename if not set -> go with upper camel - StringBuilder buf; - NameConventionUtil::join( - slices.getBuffer(), - slices.getCount(), - NameConvention::UpperCamel, - buf); - typeSet->m_typeName = buf.produceString(); - } - } - } - - if (options.m_extractDoc) - { - SLANG_RETURN_ON_FAIL(_extractDoc(&tree)); - } - - // Dump out the tree - if (options.m_dump) - { - { - StringBuilder buf; - tree.getRootNode()->dump(0, buf); - m_sink->writer->write(buf.getBuffer(), buf.getLength()); - } - - for (TypeSet* typeSet : tree.getTypeSets()) - { - const List<ClassLikeNode*>& baseTypes = typeSet->m_baseTypes; - - for (ClassLikeNode* baseType : baseTypes) - { - StringBuilder buf; - baseType->dumpDerived(0, buf); - m_sink->writer->write(buf.getBuffer(), buf.getLength()); - } - } - } - - if (options.m_defs) - { - MacroWriter macroWriter(m_sink, &m_options); - SLANG_RETURN_ON_FAIL(macroWriter.writeDefs(&tree)); - } - - if (options.m_outputPath.getLength()) - { - MacroWriter macroWriter(m_sink, &m_options); - SLANG_RETURN_ON_FAIL(macroWriter.writeOutput(&tree)); - } - - return SLANG_OK; -} - -/// Execute -SlangResult App::executeWithArgs(int argc, const char* const* argv) -{ - Options options; - OptionsParser optionsParser; - SLANG_RETURN_ON_FAIL(optionsParser.parse(argc, argv, m_sink, options)); - SLANG_RETURN_ON_FAIL(execute(options)); - return SLANG_OK; -} - -} // namespace CppExtract - - -/* -The typical command line for producing generated slang files. Can be determined by setting -`dumpCommandLine` belong and compiling. - -``` --d E:\git\slang-jsmall-nvidia\source\slang\ slang-ast-support-types.h slang-ast-base.h -slang-ast-decl.h slang-ast-expr.h slang-ast-modifier.h slang-ast-stmt.h slang-ast-type.h -slang-ast-val.h -strip-prefix slang- -o slang-generated -output-fields -mark-suffix _CLASS -``` - -A command line to try and parse the slang.h - -``` --d E:\git\slang-jsmall-nvidia slang.h -mark-suffix _CLASS -dump -unmarked -unit-test -``` -*/ - -int main(int argc, const char* const* argv) -{ - using namespace CppExtract; - using namespace Slang; - - { - ComPtr<ISlangWriter> writer(new FileWriter(stderr, WriterFlag::AutoFlush)); - - RootNamePool rootNamePool; - - SourceManager sourceManager; - sourceManager.initialize(nullptr, nullptr); - - DiagnosticSink sink(&sourceManager, Lexer::sourceLocationLexer); - sink.writer = writer; - - // Set to true to see command line that initiated C++ extractor. Helpful when finding issues - // from solution building failing, and then so being able to repeat the issue - bool dumpCommandLine = false; - - if (dumpCommandLine) - { - StringBuilder builder; - - for (Index i = 1; i < argc; ++i) - { - builder << argv[i] << " "; - } - - sink.diagnose(SourceLoc(), CPPDiagnostics::commandLine, builder); - } - - App app(&sink, &sourceManager, &rootNamePool); - - try - { - if (SLANG_FAILED(app.executeWithArgs(argc - 1, argv + 1))) - { - sink.diagnose(SourceLoc(), CPPDiagnostics::extractorFailed); - return 1; - } - if (sink.getErrorCount()) - { - sink.diagnose(SourceLoc(), CPPDiagnostics::extractorFailed); - return 1; - } - } - catch (...) - { - sink.diagnose(SourceLoc(), CPPDiagnostics::internalError); - return 1; - } - } - return 0; -} |