Initial dev

.clang-format

@@ -0,0 +1,137 @@
+---
+Language: Cpp
+# BasedOnStyle: Mozilla
+AccessModifierOffset: -3
+AlignAfterOpenBracket: Align
+AlignArrayOfStructures: Left
+AlignConsecutiveMacros: false
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Left
+AlignOperands: true
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllConstructorInitializersOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: Empty
+AllowShortCaseLabelsOnASingleLine: true
+AllowShortFunctionsOnASingleLine: Inline
+AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: Yes
+BinPackArguments: false
+BinPackParameters: false
+BraceWrapping:
+ AfterCaseLabel: false
+ AfterClass: false
+ AfterControlStatement: Never
+ AfterEnum: false
+ AfterFunction: false
+ AfterNamespace: false
+ AfterObjCDeclaration: false
+ AfterStruct: false
+ AfterUnion: false
+ AfterExternBlock: false
+ BeforeCatch: false
+ BeforeElse: false
+ IndentBraces: false
+ SplitEmptyFunction: false
+ SplitEmptyRecord: false
+ SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Custom
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeComma
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeComma
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit: 0
+CommentPragmas: '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 3
+ContinuationIndentWidth: 3
+Cpp11BracedListStyle: false
+DeriveLineEnding: true
+DerivePointerAlignment: false
+DisableFormat: false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: false
+ForEachMacros:
+ - foreach
+ - Q_FOREACH
+ - BOOST_FOREACH
+IncludeBlocks: Preserve
+IncludeCategories:
+ - Regex: '^"(llvm|llvm-c|clang|clang-c)/'
+ Priority: 2
+ SortPriority: 0
+ - Regex: '^(<|"(gtest|gmock|isl|json)/)'
+ Priority: 3
+ SortPriority: 0
+ - Regex: '.*'
+ Priority: 1
+ SortPriority: 0
+IncludeIsMainRegex: '(Test)?$'
+IncludeIsMainSourceRegex: ''
+IndentCaseLabels: true
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentWidth: 3
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+MacroBlockBegin: ''
+MacroBlockEnd: ''
+MaxEmptyLinesToKeep: 3
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 3
+ObjCSpaceAfterProperty: true
+ObjCSpaceBeforeProtocolList: false
+PenaltyBreakAssignment: 3
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PointerAlignment: Left
+ReflowComments: true
+SortIncludes: false
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: false
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: false
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpaceBeforeSquareBrackets: false
+Standard: Latest
+StatementMacros:
+ - Q_UNUSED
+ - QT_REQUIRE_VERSION
+TabWidth: 8
+UseCRLF: false
+UseTab: Never
+...

.gitignore

@@ -1,2 +1,3 @@
 [Bb]uild*/*
-CMakeLists.txt.user
+CMakeLists.txt.user
+*.md.backup

CMakeLists.txt

@@ -0,0 +1,25 @@
+cmake_minimum_required(VERSION 3.11)
+
+project("Antelope Project Management System")
+
+# Add dependent libraries.
+# Make sure this happens BEFORE we include our common settings,
+# otherwise we'll be compiling outside libraries with -Wall,
+# -Wextra, -Werror
+add_subdirectory( depends )
+
+# Add some common stuff.
+include( ./common.cmake REQUIRED )
+
+
+add_subdirectory( common )
+add_subdirectory( project )
+add_subdirectory( aproj )
+#add_subdirectory( aproj-qt )
+
+
+option(BUILD_TESTS "Build and run the tests." On)
+if(BUILD_TESTS)
+ enable_testing()
+ add_subdirectory( test )
+endif()

LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2022-current EOS Network Foundation (ENF) and its contributors.
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,7 +1,93 @@
+# ANTLER Project Tools
 
-# Antelope Project Management System
+ANTLER Project Tools (aproj) is a set of tools to help in the
+generation of smart contracts intended for deployment to an
+[Antelope](https://github.com/AntelopeIO/) blockchain.
 
+This set of tools will help the developer create, maintain, build, and
+test smart contracts.
 
-## See
+
+## Usage
+
+For now, please see the [Intial Design Document](./docs/project_manager.md) for usage.
+
+## Runtime Dependencies
+
+The following tools are required for aproj to work at runtime:
+- CMake v3.11
+- aproj requires [`gh`](https://cli.github.com/). Note that you may need
+to [authenticate](https://cli.github.com/manual/) before this will
+work.
+
+
+## Build Dependencies
+
+Building aproj requires the following dependencies:
+- C++20 compiler (e.g. gcc-10 or clang-13).
+- [CMake](https://cmake.org/overview/) version 3.11 or greater (note the requirement [here](./CMakeLists.txt#L1)).
+
+Additionally we recomend using [ninja build](https://ninja-build.org/) for fast builds.
+
+
+## Building
+
+Assuming you have ninja and the other dependencies installed, from the project root, the following will build the project:
+```bash
+mkdir -p Build \
+ && cd Build \
+ && cmake -GNinja -DCMAKE_BUILD_TYPE=Release \
+ && cmake --build .
+```
+
+Note that CMake's FetchDependencies command is used. It occasiaonally
+errors out. If this happens, it may be necessary to remove the `_deps`
+directory from your build directory.
+
+## Test
+
+Currently, the following will run some automated tests:
+```bash
+ninja && ninja test
+```
+
+## Maintaining
+
+Directories in the project root:
+- aproj: This contains the various CLI tools, all of which depend on the project library.
+- common: This contains a common library that might be useful elsewhere and parts of libsb, a 3rd party utility library.
+- project: This is standalone library that contains the majority of implementation that creates and maintains the `project.yaml` file as well as initialize and populate the project's directory tree, among other things.
+- test: This direcory contains a number of unit tests. In future, it's likely to contain system level tests as well.
+- depends: This directory contains the CMake instructions for including libraries.
+
+
+## License
+
+The majority of this project is licensed using the MIT License as
+found [here](./LICENSE).
+
+A [few files](./common/sb) are directly included from
+[libsb](https://github.com/ScottBailey/libsb), which uses the
+`BSD-3-Clause` license. Note that these files independently contain
+their own license information.
+
+Additionally, apack depends on [Rapid YAML](https://github.com/biojppm/rapidyaml),
+which uses the `MIT` license.
+
+
+## Miscellaneous
+
+### What does `aproj` stand for?
+
+It's a shortening of `antler-proj`.
+
+### Is ANTLER an acronym?
+
+Yes, it is. Or maybe it's a
+[backronym](https://en.wikipedia.org/wiki/Backronym)?
+
+Regardless, it's ANother TransLator Environment and Runtime.
+
+### Initial Issue
 
 https://github.com/AntelopeIO/cdt/issues/62

aproj/CMakeLists.txt

@@ -0,0 +1,26 @@
+
+#
+# These files are generally built in a common way, so here are some functions to simplify the process.
+#
+
+function(add_aproj target_name files)
+ add_executable(${target_name} ${files})
+ set_property(TARGET ${target_name} PROPERTY CXX_STANDARD 20)
+ target_link_libraries(${target_name} PUBLIC antler-project)
+ target_include_directories(${target_name} PRIVATE . )
+ install(FILES $<TARGET_FILE:${target_name}> COMPONENT Runtime DESTINATION .)
+endfunction()
+
+
+file(GLOB src_cpp ./*.cpp)
+
+foreach(file_name IN ITEMS ${src_cpp})
+ if(${CMAKE_VERSION} VERSION_LESS "3.20")
+ get_filename_component(fn ${file_name} NAME)
+ else()
+ cmake_path(GET file_name FILENAME fn)
+ endif()
+
+ string(REPLACE ".cpp" "" name ${fn})
+ add_aproj("${name}" "${fn}")
+endforeach()