UnittestNames
    Optional. Empty for no generation.
    Unittest. Name of Unittest For Generation.

Plugins

Plugins In Update mode, Generator will copy folders under include/External, src/External, unittest/External to workspace. Option: vcc/versioning/git

Exports

Exports In Update Mode, Generator will update Makefile so that dll, exe will be copied after make release. Note: JNA cannot read debug mode dll. In Generate Mode, Generator will generate class, enum, bridge according to TypeWorkspace stated above.

Interface
    Only accept "Java" at the moment. Pending to have Swift and Cpp

Workspace
    Destination of Target Project. Recommand to use relative path.

IsExportExternalLib
    true or false
    If true, copy all files in directory lib to with main exe and dll.
    
ExportDirectoryDll
    Relative path based on Workspace.
    After changed, please trigger Update Mode to update Makefile.
    When make, dll file will be copied to the path specified.
    For Java, it must have prefix src/main/resources

ExportDirectoryExe
    Relative path based on Workspace.
    After changed, please trigger Update Mode to update Makefile.
    When make, dll file will be copied to the path specified.

DllBridgeDirectory
    Relative path based on Workspace.
    In Generation Mode, Dll bridge will be generated in path specified.
    In Java, it must have prefix src/main/java

FormDirectory
    Relative path based on Workspace. If empty, then use ObjectDirectory
    In Generation Mode, Java class file will be generated in path specified.
    In Java, it must have prefix src/main/java

ObjectDirectory
    Relative path based on Workspace.
    In Generation Mode, Java class file will be generated in path specified.
    In Java, it must have prefix src/main/java

TypeDirectory
    Relative path based on Workspace.
    In Generation Mode, Java class file will be generated in path specified.
    In Java, it must have prefix src/main/java

Naming rules

Generator will only copy the folder without renaming but using c++ class name as file name while converting c++ class to Java class

C++ Folder: name must be lowercase and no seperator such as "" Filea: name must be lowercase and sperated by ""

Java Folder: name must be lowercase and no seperator such as "_" Filea: name must be same as Class name

Update Rule

Procedure:

1. Download template.

2. Switch to corresponnding tag.

3. Synchronize files under External/VCC/Core and folder specified under Plugins in vcc.json

4. If file does not exist in workspace, then add files.

5. If file does not exist in template, then delete files.

6. If file both exists in workspace and template but not the same, then update files with following rules. (Samples in vpg_file_sync_service_test.cpp) 6.1 Check file of workspace has following line at line 1. // <vcc:vccproj sync="FULL"/> Value of sync: FULL: Follow tag in file content. DEMAND: Replace all file content except tag has marked RESERVE. SKIP: No update. FORCE: Replace everything.

    Note: By default it is FULL mode.
    Note: current version only support sync only. Will add generation tag letter.
   

   6.2 In file content, if inherited project file and current project file both has that tag with same name, generateor will update with following rules. Inherited Project: // <vcc:tagA sync="RESERVE"> Code A // </vcc:tagA>

    Current Project: 
        // <vcc:tagA sync="REPLACE">
        Code B
        // </vcc:tagA>
   
    In the example, Inherited Project file and Current Project file both have tag with tagA. Then generator will update the code with following rules.
    Value of sync:
        RESERVE: No update.
        REPLACE: Replace current project file content by inherited project.
        ALERT: Show different it there is change. Not support at the moment.
   
    Special Tag:
        vccconfig: Content will be force updated according to vcc.json in Update Mode and Generate Mode.
   

Generate Rule

The final objective is that user only need to handle enum class like sql table and logic in service and manager only. Other thing will be auto generate. Note:

1. Set is not supported at the moment. Note:
2. For any not support type / macro e.g. SET macro, std::complex, etc. User may need to use ReadLock, WriteLock of Property Accessor to handle manually. Sample in
3. vpg_file_generation_manager_test.cpp
4. vpg_property_accessor_generation_service_test.cpp

Definition of Program Structure Class: C++ Class. Data storage. Factory: Generate class based on Enum. Form: Class with Manager. Call Manager to do action. Manager: Class with model. Call service to modify model. PropertyAccessor: Bridge between Control and model with thread safe access. Plending to have validation, trigger etc. Service: Class with static function only. It is used to provide logic. Structure: C++ Structure. Used to support huge data process. Not support at the moment.

Definition of Enum Class Class Property file: file name with format projectPrefix_objectName_property.hpp If project prefix is defined in vcc.json, then all files and classes that not having project prefix will be skipped. Enum Class file: file name with format projectPrefix_enumName.hpp; If project prefix is defined in vcc.json, then all files and classes that not having project prefix will be skipped. All enum that used in class must be defined in TypeWorkspace. Otherwise will have compile error.

Restriction

• Field names should be long form and capital letter.
• Field names should having component with descending order. E.g. WorkspaceSource instead of SourceWorkspace
• All fields should use macro in class_macro.hpp.
• Not allow to use using namespace std, there are so many bugs. If want to use std library, please use std::wstring etc.
• The program is based on std::wstring. Should not use std::string.
• Only support basic type with std::wstring as Other language may not support the type defined in C++.
• Does not allow ClassA contains ClassB and ClassB contains ClassA. As there is Clone method in Macro which is not trivial.

Procedure 1. Read all files in TypeWorkspace. 2. For all Class Property file, will generate Class file etc. 3. All Enum Class File will export to interface like java etc. Only support Java at the moment.

Note Under DllFunctions.h, user can have custom function with C basic type within extern "C" { } but the function must start with DLLEXPORT. When export java interface, the custom function also will be generated. But the usage of PointerByReference will be review later. Please do not write any codes within tag dllInterfaceHeader and dllInterface. They will be overriden by Generator.

Sample: in DllFunctions.h

// <vcc:vccproj gen="DEMAND"/>
#ifndef DLL_FUNCTIONS_H
#define DLL_FUNCTIONS_H

#include <string>

#ifdef _WIN32
#define DLLEXPORT __declspec (dllexport) 
#else
#define DLLEXPORT extern 
#endif

// <vcc:dllInterfaceHeader gen="FORCE">
#include "object_factory.hpp"
#include "property_accessor_factory.hpp"
#include "property_accessor_macro.hpp"

using namespace vcc;
// </vcc:dllInterfaceHeader>

extern "C"
{

DLLEXPORT int GetVersion(wchar_t **str);

DLLEXPORT void *CreateObject(int64_t objectType);

// <vcc:dllInterface gen="FORCE">
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER(bool, Bool)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER(char, Char)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER(wchar_t, Wchar)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER(int, Int8)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER(int, Uint8)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER(int, Short)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER(int, UnsignedShort)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER(long, Int)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER(long, UnsignedInt)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER(long, Long)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER(long, UnsignedLong)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER(float, Float)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER(double, Double)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER_STRING
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER_OBJECT
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_HEADER_CONTAINER
// </vcc:dllInterface>
}

#endif

in DllFunctions.cpp

// <vcc:vccproj gen="DEMAND"/>
#include "DllFunctions.h"

#include <locale.h>
#include <stdio.h>
#include <wchar.h>


// <vcc:dllInterfaceHeader gen="FORCE">
#include "exception_macro.hpp"
#include "i_object.hpp"
#include "lock_type.hpp"
#include "property_accessor_factory.hpp"
#include "property_accessor_macro.hpp"

using namespace vcc;
// </vcc:dllInterfaceHeader>

int GetVersion(wchar_t **str)
{
    std::wstring versionString = L"v0.0.1";
    size_t size = (versionString.length() + 1) * sizeof(wchar_t);
    *str = static_cast<wchar_t*>(malloc(size));
    if (*str == nullptr) {
        return -1;
    }
    wcscpy(*str, versionString.c_str());
    return 0;
}

#include "object_factory.hpp"
#include "object_type.hpp"
std::shared_ptr<IObject> obj = nullptr;
void *CreateObject(int64_t objectType)
{
    ObjectType tmpObjectType = static_cast<ObjectType>(objectType);
    obj = ObjectFactory::Create(tmpObjectType);
    return obj.get();
}

// <vcc:dllInterface gen="FORCE">
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL(bool, Bool, false)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL(char, Char, L'\0')
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL(wchar_t, Wchar, L'\0')
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL(int, Int8, 0)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL(int, Uint8, 0)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL(int, Short, 0)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL(int, UnsignedShort, 0)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL(long, Int, 0)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL(long, UnsignedInt, 0)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL(long, Long, 0)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL(long, UnsignedLong, 0)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL(float, Float, 0)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL(double, Double, 0)
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL_STRING
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL_OBJECT
PROPERTY_ACCESSOR_DLL_EXPORT_MACRO_DETAIL_CONTAINER
// </vcc:dllInterface>

Documentation

// {Class Attribute} enum class ##ClassName##Property { EnumA, // {Field Attribute} EnumB, // {Field Attribute} EnumC // {Field Attribute} };

Note:

1. Enum Class must be in file with ##prefix##_##class_name##_property.hpp where ##prefix## must be the Project Prefix defined in vcc.json the file name must be end with _property.hpp e.g. vpg_person_property.hpp
2. Enum Class must be defined with ##PREFIX##ClassName##Property e.g. VPGPersionProperty

Class Attribute

// [@@Form] [@@ActionArgument] [@@Result] [@@Inherit { "Class": "ClassName" }] [@@Log { "IsIndependent": true }] [@@Action { "IsIndependent": true }] [@@Thread { "IsIndependent": true } ] [@@Json { "Key.NamingStyle" : "PascalCase", "Value.DecimalPlaces":2 }] [@@Include { "SystemFiles": ["string", "vector"], "CustomFiles" : [ "a.hpp", "b.hpp" ]}] [@@Private { "Properties": { "_PropertyA": "int64_t=0", "_PropertyB": "VPGGlobal=nullptr" } } ] [@@Protected { "Properties": { "_PropertyA": "int64_t=0", "_PropertyB": "VPGGlobal=nullptr" } }] [@@Command xxx]

[]: Optional @@: Key for attributes. Need to state for attribute {}: Json format to describe Json file

[@@Form] This Class is a form. If hpp file contains both object and form, generator will generate files under Form Directory instead of Object Directory.

[@@ActionArgument] This Class is an Action Argument. Action only. It will generated in the same file with Action.

[@@Result] This Class is a Result Class. Action only. It inherits BaseResult to return Error Code and Error Message.

[@@Inherit { "Class": "ClassName" }] Generate Class that inherit ClassName Attribute: Class Value is Parent Class

[@@Log { "IsIndependent": true }] Form Only Attribute: IsIndependent Value is true or false. Default: false If value is false, Form will follow Parent Object Log Setting If Value is true, Form will have new Log config

[@@Action { "IsIndependent": true }] Form Only Attribute: IsIndependent Value is true or false. Default: false If value is false, Form will follow Parent Object Action Manager (share same history) If Value is true, Form will have new Action History (independent history)

[@@Thread { "IsIndependent": true }] Form Only Attribute: IsIndependent Value is true or false. Default: false If value is false, Form will follow Parent Object Thead Manager (share same thread pool) If Value is true, Form will have independent Thread Mamanger (independent thread pool)

[@@Json { "Key.NamingStyle" : "PascalCase", "Value.DecimalPlaces":2 }] Generate Class as Json Object. Class will have attribute ToJson, SerializeJson and DeserializeJson Attribute: Key.NamingStyle Value can be following | Value | Result | | --- | --- | | CamelCase | camelCase | | ConstantCase | CONSTANT_CASE | | DotSeparatedLowercase | dot.seperated.lowercase | | KebabCase | kebab-case | | Lowercase | lowercase | | PascalCase | PascalCase | | ScreamingSnakeCase | SCREAMING_SNAKE_CASE | | SnakeCase | snake_case | | Uppercase | UPPERCASE |

    Value.DecimalPlaces
        value is number. Declare for decimal places for double and float. If not declare, Json number will be trim tailing 0s.

[@@Include { "SystemFiles": ["string", "vector"], "CustomFiles" : [ "a.hpp", "b.hpp" ]}] Add include files in class files. Attribute: SystemFiles Array of system file names.

    CustomFiles
        Array of project file names.

[@@Private { "Properties": { "_PropertyA": "int64_t=0", "_PropertyB": "VPGGlobal=nullptr" } } ] Class Private. Properties will not be exported in Json. Please also use GETCUSTOM, GETCUSTOM_SPTR, SETCUSTOM, SETCUSTOM_SPTR if export to json is needed. For object, it will inialize at constructer. Attribute: Properties Object of property name and type pair. Can define initalize value using "=" in value. e.g. "_PropertyA": "int64_t=0" will parsed as multable int64_t _PropertyA = 0 e.g. "_PropertyB": "VPGGlobal=nullptr" will parsed as multable std::shared_ptr _PropertyB = nullptr;

[@@Protected { "Properties": { "_PropertyA": "int64_t=0", "_PropertyB": "VPGGlobal=nullptr" } }] Class Protected. Properties will not be exported in Json. Please also use GETCUSTOM, GETCUSTOM_SPTR, SETCUSTOM, SETCUSTOM_SPTR if export to json is needed. For object, it will inialize at constructer. Attribute: Properties Object of property name and type pair. Can define initalize value using "=" in value. Example same as above case.

[@@Command xxx] Command used in VCC generator, can be any text in xxx without @@

Field Attribute

Enum // {ClassMacro} [{ClassMacro}] [@@AccessMode] [@@Inherit] [@@NoHistory] [@@NoJson] [@@Initialize { "Properties: ["0", "true"]" }] [@@ActionResult { "Redo.Class": "ClassName", "Undo.Class" : "ClassName" }] [@@Command xxx]

{...}: Compulsory []: Optional @@: Key for attributes. Need to state for attribute

{Enum} Enum class enum. Used in property Accessor

{ClassMacro} Macro stated in class_macro.hpp. If it is not match with any class macro in class_macro.hpp, the rest will be ignored Note: No Initialize method in Class Object (except Form). Otherwise need to handle more than one place after adjustment of properties. Please use recreation of object if initialize is needed. Note: Cannot use try catch in MACRO validate. And "exception_macro.hpp" cannot be included in .hpp. It will have compile error. Only "throw" can be used. Note: In argument or customProcedure, use "value" to get argument input.

Current Options for Properties:
    Custom
    | Macro | Description | Example |
    | --- | --- | --- |
    | GETCUSTOM(type, name, customProcedcure) | Getter only. Does not contain real variable. | GETCUSTOM(bool, IsObjectExists, return _Object != nullptr) |
    | SETCUSTOM(varName, type, customProcedcure) | Setter only. Does not contain real variable. Argument is value. | SETCUSTOM(IsTrue, bool, _IsTrue = (_Object != nullptr) ? true : value; ) |
    | GETCUSTOM_SPTR(type, name, customProcedcure) | Getter only. Does not contain real variable. | GETCUSTOM_SPTR(GitObject, GitObject, return _Object != nullptr ? _Object : std::shared_ptr<GitObject>(); ) |
    | SETCUSTOM_SPTR(name, type, customProcedcure) | Setter Only. Does not contain real variable. | SETCUSTOM_SPTR(IsTrue, GitObject, object, _IsTrue = gitObject != nullptr; ) |

    GETSET
    | Macro | Description | Example |
    | --- | --- | --- |
    | GETSET(type, name, defaultValue) |  Normal Type and Enum. | GETSET(std::wstring, Name, L"") |
    | GETSET_VALIDATE(type, varName, defaultValue, validate) | Normal Type and Enum. | GETSET(std::wstring, Name, L"",if (value.empty() throw std::invalid_argument("Value cannot be empty"));) |
    | GETSET_SPTR(type, name, ...) | Object. Initialize in class constructor. ... is initialization and should have same order as class constructor. | GETSET_SPTR(GitOption, Name, _LogConfig, L"Remark") |
    | GETSET_SPTR_NULL(type, name) | Object and initialize as nullptr. Please initialize it after class creation. | GETSET_SPTR_NULL(GitOption, Name) |
    | GETSET_VALIDATE_SPTR_NULL(type, varName, validate) | Object and initialize as nullptr. Please initialize it after class creation. | GETSET_VALIDATE_SPTR_NULL(GitOption, Name, if (value == nullptr) throw std::invalid_argument("Value cannot be null");)  |
    
    Note: There is no GETSET_VALIDATE_SPTR as the order of macro argument will become GETSET_VALIDATE_SPTR(type, varName, validation, ...) which is not correct. If initializtion is needed in this case, please use @@Initialize to define default values.
    
    VECTOR
    | Macro | Description | Example |
    | --- | --- | --- |
    | VECTOR(type, name) | std::vector<type>. Vector for Normal Type and Enum. | VECTOR(double, Name) |
    | VECTOR_VALIDATE(type, name, validate) | std::vector<type>. Vector for Normal Type and Enum. Validate for each element when insertion. | VECTOR_VALIDATE(double, Name, if (value < 0) throw std::invalid_argument("Value cannot be negative."); ) |
    | VECTOR_SPTR(type, name) | std::vecotr<std::shared_ptr<type>>. Vector for Object. | VECTOR_SPTR(GitOption, Name) |
    | VECTOR_VALIDATE_SPTR(type, name, validate) | std::vecotr<std::shared_ptr<type>>. Vector for Object. | VECTOR_VALIDATE_SPTR(GitOption, Name, if (value == nullptr) throw std::invalid_argument("Value cannot be nullptr.");) |
    
    MAP
    | Macro | Description | Example |
    | --- | --- | --- |
    | MAP(type1, type2, name) | Map of Normal Type and Enum. | MAP(std::wstring, double, Name) |
    | MAP_VALIDATE(type1, type2, name, validate) | Map of Normal Type and Enum. Validate value when insertion. | MAP_VALIDATE(std::wstring, double, Name, if (value < 0) throw std::invalid_argument("Value cannot be negative.");) |
    | MAP_SPTR_R(type1, type2, name) | Map of Object. Only allow Object at type2. If want to set object at type1, please use int64_t. | MAP(std::wstring, GitLog, Log) |
    | MAP_VALIDATE_SPTR_R(type1, type2, name, validate) | Map of Object. Only allow Object at type2. If want to set object at type1, please use int64_t. Validate value when insertion. | MAP_VALIDATE_SPTR_R(std::wstring, GitLog, Log, if (value == nullptr) throw std::invalid_argument("Value cannot be nullptr.");) |
    
    
    ORDERED_MAP
    | Macro | Description | Example |
    | --- | --- | --- |
    | ORDERED_MAP(type1, type2, name) | std::vector<std::pair<type1, type2>>. Allow to use method of vector and map. | ORDERED_MAP(std::wstring, double, Tax) |
    | ORDERED_MAP_VALIDATE(type1, type2, name, validate) | std::vector<std::pair<type1, type2>>. Allow to use method of vector and map. Validate value when insertion. | ORDERED_MAP_VALIDATE(std::wstring, double, Tax, if (value < 0) throw std::invalid_argument("Value cannot be negative.");) |
    | ORDERED_MAP_SPTR_R(type1, type2, name) | std::vector<std::pair<type1, std::shared_ptr<type2>>>. Allow to use method of vector and map. | ORDERED_MAP_SPTR_R(std::wstring, Student, Students) |
    | ORDERED_MAP_VALIDATE_SPTR_R(type1, type2, name, validate) | std::vector<std::pair<type1, std::shared_ptr<type2>>>. Allow to use method of vector and map. Validate value when insertion. | ORDERED_MAP_VALIDATE_SPTR_R(std::wstring, Student, Students, if (value == nullptr) throw std::invalid_argument("Value cannot be nullptr.");) |

    Pending for SET

Current Options for Manager: (Form Only)
    | Macro | Description | Example |
    | --- | --- | --- |
    | MANAGER_SPTR(type, name, ...) |  Manager. Initialize in class constructor. The inialization is in order. | MANAGER_SPTR(GitManager, GitManager1, _LogConfig) |
    | MANAGER_SPTR_NULL(type, name, ...) |  Manager. Initialize at Initialize() | MANAGER_SPTR_NULL(GitManager, GitManager1) |
    | MANAGER_SPTR_PARENT(type, name, parentClass) |  Manager. If value is nullptr, then will use parentClass->Get##name(), else will use local manager. Please ensure parentClass is Form also and have same type. Initialize as nullptr at Initialize(). | MANAGER_SPTR_NULL(GitManager, GitManager1, GitBaseManager) |

Current Option for Action:
    If action has error, then will not add to action list in ActionManager but throw exception or return result.
    | Macro | Description | Example |
    | --- | --- | --- |
    | ACTION(name) | Generator will create void Do##name() and generate Action Class. Please handle logic in .cpp file. | ACTION(AddWorkspace) |
    | ACTION_WITH_ARG_SPTR(name, type) | Generator will create void Do##name(type value) and generate Action Class. type must be class name. Argument Class must exists and have class tag @@ActionArgument. | ACTION_WITH_ARG_SPTR(AddWorkspace, VPGAddWorkspaceArgument) |

Note1: Class cannot be initialie in definition. In usage, GETSET_SPTR === GETSET_SPTR_NULL, MANAGER_SPTR === MANAGER_SPTR_NULL. But Generator will generate initailization in class constructor if using GETSET_SPTR or MANAGER_SPTR.
Note2: If want to have validation when set property, SETCUSTOM and SETCUSTOM_SPTR can be used.

[{ClassMacro}] Define second Class Macro. It will share same enum with the first one. As most macro contains both getter and setter, this option is only available for GETCUSTOM, GETCUSTOM_SPTR, SETCUSTOM, SETCUSTOM_SPTR.

[@@AccessMode] Default is @@ReadWrite. Option: @@ReadWrite Allow Read and Write through Property Accessor @@ReadOnly Allow Read Only via Property Accessor @@WriteOnly Allow Write Only via Property Accessor @@NoAccess Cannot Access via Property Accessor

[@@Inherit] If stated, generate will not generate Getter and Setter, Manager, Action, etc.

[@@NoHistory] Action Only. Will not add to Action Manager. After executing Do, this action cannot be found in Action List. So, this action cannot be Undo.

[@@NoJson] For class declare @@Json Only. Will not generate Json for current property. For those temp properties that do not need to be recored.

[@@Initialize { "Properties: ["0", "true"]" }] For inializtion. The value will be inialized in class constructor. If it is basic type, add one default value to array. e.g. ["0", "true", "\L"Test String""] If it is Object, add all argument in order. e.g. ["0", "true", "\L"Test String""] If it is vector or map, add elements that can be insert to vector or map. E.g. ["std::make_shared(0)", "std::make_shared(1)"]

[@@ActionResult { "Redo.Class": "ClassName", "Undo.Class" : "ClassName" }] For Action Only. ClassName must have tag @@ActionResult. If not stated, Action will return OperationResult which contains ErrorCode and ErrorMessage Only.
Attributes: Redo.Class: Return Class for Do or Redo. Undo.Class: Return Class for Undo.

[@@Command xxx] Command used in VCC generator, can be any text in xxx without @@

Example

There is TypeWorkspace in vcc.json
"TypeWorkspace": "include/Type"

Create .hpp file under include/Type with suffix _property.hpp
e.g. vpg_generation_option_property.hpp

// @@json
enum class VPGGenerationOptionExportProperty
{
    InterfaceType // GETSET(VPGGenerationOptionInterfaceType, Interface, VPGGenerationOptionInterfaceType::Java)
};

// @@json { "Key.NamingStyle" : "PascalCase" }
enum class VPGGenerationOptionProperty
{
    Version, // GETSET(std::wstring, Version, L"v0.0.1");
    ProjectType,  // GETSET(VPGProjectType, ProjectType, VPGProjectType::VccModule);
    WorkspaceSourceGitUrl, // GETSET(std::wstring, WorkspaceSourceGitUrl, L"");
    WorkspaceSource, // GETSET(std::wstring, WorkspaceSource, L"");
    WorkspaceDestination, // GETSET(std::wstring, WorkspaceDestination, L"");

    // --------------------------------------------------
    // Config
    // --------------------------------------------------
    // Project
    ProjectPrefix, // GETSET(std::wstring, ProjectPrefix, L"");

    ProjectName, // GETSET(std::wstring, ProjectName, L"VCCModule"); @@Command Need to assign Default Name first to pass validation
    ProjectNameDll, // GETSET(std::wstring, ProjectNameDll, L"libVCCModule"); @@Command Need to assign Default Name first to pass validation
    ProjectNameExe, // GETSET(std::wstring, ProjectNameExe, L"VCCModule"); @@Command Need to assign Default Name first to pass validation
    IsGit, // GETSET(bool, IsGit, false);

    IsExcludeUnittest, // GETSET(bool, IsExcludeUnittest, false);
    IsExcludeVCCUnitTest, // GETSET(bool, IsExcludeVCCUnitTest, false);

    // Files
    TypeWorkspace, // GETSET(std::wstring, TypeWorkspace, L"include/Type");

    ExceptionTypeDirectory, // GETSET(std::wstring, ExceptionTypeDirectory, L"include/Type");
    ObjectTypeDirectory, // GETSET(std::wstring, ObjectTypeDirectory, L"include/Type");

    ObjectDirectoryHpp, // GETSET(std::wstring, ObjectDirectoryHpp, L"include/Model");
    ObjectDirectoryCpp, // GETSET(std::wstring, ObjectDirectoryCpp, L"src/Model");
    PropertyAccessorDirectoryHpp, // GETSET(std::wstring, PropertyAccessorDirectoryHpp, L"include/PropertyAccessor");
    PropertyAccessorDirectoryCpp, // GETSET(std::wstring, PropertyAccessorDirectoryCpp, L"src/PropertyAccessor");

    ObjectFactoryDirectoryHpp, // GETSET(std::wstring, ObjectFactoryDirectoryHpp, L"include/Factory");
    ObjectFactoryDirectoryCpp, // GETSET(std::wstring, ObjectFactoryDirectoryCpp, L"src/Factory");
    PropertyAccessorFactoryDirectoryHpp, // GETSET(std::wstring, PropertyAccessorFactoryDirectoryHpp, L"include/Factory");
    PropertyAccessorFactoryDirectoryCpp, // GETSET(std::wstring, PropertyAccessorFactoryDirectoryCpp, L"src/Factory");
    
    // Plugins
    Plugins, // VECTOR(std::wstring, Plugins);

    // Export
    Exports // VECTOR_SPTR(VPGGenerationOptionExport, Exports);
};

namespace others {
    enum class VPGGenerationOptionExportProperty
    {
        InterfaceType // GETSET(VPGGenerationOptionInterfaceType, Interface, VPGGenerationOptionInterfaceType::Java)
    };
}

Then use generation. It will auto create class, property, factory, property accessor

Export to Java

Assume that using Maven Java Project. The library will be compiled to resources folder. For MacOS, only test with M Chips.

Please put following code to Pom. Only test for version >= 5.14.0.

    <dependencies>
        <dependency>
            <groupId>net.java.dev.jna</groupId>
            <artifactId>jna</artifactId>
            <version>5.14.0</version>
        </dependency>
    </dependencies>

Note: NetBeans cannot find net.java.dev.jna, It can only find old version com.sun.jna. After verison 3.0.0, con.sun.jna has been renamed as net.java.dev.jna but the import files still called com.sun.jna. For the com.sun.jna version, it does not support Mac M Chips and throw linkage error.

Note: When using jna, when we put "vpg" as dll name, it will auto searh with the libaray with name libvpg.dylib under src/main/resources Please having lib name with libxxx.dylib format

import com.sun.jna.Library;
import com.sun.jna.Native;

interface DllFunctions extends Library {
    DllFunctions INSTANCE = (DllFunctions) Native.load("vpg", DllFunctions.class);

    int GetVersion();
}
public class Test {

    public static void main(String[] args) {
        System.out.println(DllFunctions.INSTANCE.GetVersion());
    }
}

Java Type Mapping

According to JNA (Java Native Access), here is the map of types between c++ and Java. Better to use below type only. If not using below type, generator will use static cast. | C++ Type | Java Type | | --- | --- | | char | byte | | short | short | | wchart_t | char | | int | int | | bool | boolean | | long | NativeLong | | long long | long | | float | float | | double | double | | char* | String | | void* | pointer |

Java UI

Here are some notes for Java UI.

Please ensure the program have following lines in main.

Set UI style be nature current platform style.

try {
    UIManager.setLookAndFeel(UIManager.getCrossPlatformLookAndFeelClassName());
} 
catch (ClassNotFoundException | IllegalAccessException | InstantiationException | UnsupportedLookAndFeelException e) {
    // handle exception
}

Set MacOS menu bar be screen menu bar.

System.setProperty("apple.laf.useScreenMenuBar", "true");

Sample

/**
* @param args the command line arguments
*/
public static void main(String args[]) {
    try {
        UIManager.setLookAndFeel(UIManager.getCrossPlatformLookAndFeelClassName());
    } 
    catch (ClassNotFoundException | IllegalAccessException | InstantiationException | UnsupportedLookAndFeelException ex) {
        java.util.logging.Logger.getLogger(Main.class.getName()).log(java.util.logging.Level.SEVERE, null, ex);
    }
    // Set the property to use the screen menu bar on macOS
    System.setProperty("apple.laf.useScreenMenuBar", "true");
    
    /* Create and display the form */
    java.awt.EventQueue.invokeLater(() -> {
        new Main().setVisible(true);
    });
}

Versioning Common Codebase Project Generator VSCode Extension

Pre-Requirement

Same as Versionin Common Codebase Project Generator

Clone from git

After download from git please enter following to terminal

npm install

Procedure

1. Download VCCProject Generator sourcecode from GitHub to ~/Document/VCC folder if not exists.
2. Check the version of VCCProject Generator and Extension are the same. If not, switch to that version and Make. It will use some time to compile.
3. Execute the command listed in Options.

Options

There are serveral options. (workspace means first workspace shown in project tree of VSCode) Details refer to Versionin Common Codebase Project Generator.

1. Create C++ Complex Project Execute: vpg -Add -interface CPPCOMPLEX -workspace-destination workspace

2. Create C++ EXE Project Execute: vpg -Add -interface CPPEXE -workspace-destination workspace

3. Create C++ DLL Project Execute: vpg -Add -interface CPPDLL -workspace-destination workspace

4. Create VCC Complex Project Execute: vpg -Add -interface VCCCOMPLEX -workspace-destination workspace

5. Create VCC EXE Project Execute: vpg -Add -interface VCCEXE -workspace-destination workspace

6. Create VCC DLL Project Execute: vpg -Add -interface VCCDLL -workspace-destination workspace

7. Update VCC Project Execute: vpg -Update -workspace-destination workspace

8. Generate VCC Project Execute: vpg -Generate -workspace-destination workspace

Tutorial for Create VCC DLL Project to generate dll with Java Interface

1. For C++, create a folder and use VSCode open it.

2. For Java, create a folder next to C++ folder and create a Maven Project within the folder |- CppProjectFolder |- JavaProjectFolder

3. Place following code to pom.xml.

   net.java.dev.jna jna 5.14.0

4. In C++ Project VSCode bar, type "> Create VCC DLL Project" and execute. VSCode will download corresponding VCC Project Generator from GitHub to ~/Documents/VCC in local computer.

5. Open vcc.json file, update ProjectPrefix, ProjectName, ProjectNameDll. ProjectNameDll must be started with prefix "lib" for JNA. In this tutorial, use VPG as Project Prefix.

   Under Exports, write config like following "Exports": [ { "Interface": "Java", "Workspace": "../JavaProjectFolder", "IsExportExternalLib": true, "ExportDirectoryDll": "src/main/resources", "ExportDirectoryExe": "", "DllBridgeDirectory": "src/main/java/company/name", "ObjectDirectory": "src/main/java/company/name/model", "TypeDirectory": "src/main/java/com/company/name/type" } ]

   Note: company/name is company / organization name, please replace to what you need.

6. In C++ Project VSCode bar, type "> Update VCC Project" and execute.

7. Go to VSCode Explorer, under "include/Type", create a file with name vpg_test_property.hpp

8. In vpg_test_property.hpp, write code

#pragma once

enum class VPGTestProperty
{
    PropertyA // GETSET(std::wstring, PropertyA, L"")
};

Note: If file name is not end with _property.hpp but in type workspace folder, generate will not generate the c++ class and property accessor. But will also export to Java interface. 9. In C++ Project VSCode bar, type "> Generate VCC Project" and execute. 10. In terminal, type "make release -j10" and execute. 11. Generator has already been generated whole C++ Project structure and Java Project Structure. Note: As C++ is using shared_ptr when handle object, Need to find some place to store the pointer first. Otherwise, you will get freed pointer in Java. Note: At the moment, there is no place to create object and return pointer to Java, user need to create object manually. Create pointer problem will be handled in next stage (Form Handling).

History

The project is start from 2022-06-22. As Document Versioning is needed but no solution can be found. Also, existing document processors have some interesting behaviour, such as

When save, will save from beginning. Auto create new style which will make charactors hiden. When press Enter at Title, the new line will have new style that make the content disappear. When having outline then save, document cannot save correctly. The Index cannot recognize item number. When save, item numbers disappear. When handling thousand pages document, it lags. Some will hang and quit. Docx cannot save as docx by default. Cannot save in local storage by default. Security Problem. etc.

As those problems have not been solve until 2022-06-22, I believe that they are properties instead of bugs. I better to write a document processor myself. When I try to write a document processor with versioning, I find that I should write a git application instead of document processor. But I need to write a document processor before creating a git application project. As most codes are mechanical work, I write a code generator to write those projects instead of writing one by one. So, I need to write 3 applications.

Firstly, I try to use SwiftUI + dynamic library first as I don’t need to create website and handle payment progess. But I can find no way to create virtual ListView. Secondly, as SwiftUI seems difficult to me, I try to use C# + dynamic library as I am experienced in C#. But I found that Linux and MacOS does not support C# and Visual Studio does not support multi-platform, then I give up. Thirdly, I try to use Java + dynamic library as Java is multiplatform. But I find that NetBeans has not supported C++ long time ago. Finally, I try to use VSCode with g++. Then I try about one month to setup the makefile. In fact, there are no templates for multiplatform with gtest. I need to study and write makefiles (both library and executable) from the beginning. In fact, I have used about 6 months to investigate. I think I better write a program to skip one year effort.

In fact, the first release is 2024-05-05, I have used one and a half year (although I can only write the code at weekend and after work) to write basic structure, which is not complete yet.

Hope everyone can skip at least 2 years effort and dont need to ask same question again and again.

How to Contribute

It is my first git opensource project. In fact, I don't know what to do. If you want to have new feature or report bugs, please tell me via GitHub or X(Twitter). If you want to contribute, please create branch and tell me to merge when finished. I may need to modify the code to fit the style Note that it is open source no license coorporation project, code will be modified without notification.

Contact

X(Twitter) @VCCProject

Release Log

[v0.4.2] - 2025-10-29: Generate Action Unittest

• Generate Action Unittest

[v0.4.1] - 2025-08-24: Review Function Name

• Review function naming from PascalCase to CamelCase

[v0.4.0] - 2025-08-03: Upgrade to support C++23

• Support C++23 (Note: MacOS support C++23 now)

[v0.3.7] - 2025-07-27: Review - Review Namespace

• Review using namespace vcc: add vcc:: before function instead of using namespace vcc
• Support namespace in TypeWorkspace

[v0.3.6] - 2025-06-01: Review - Review Class Macro

• Review GETSET_SPTR and MANAGER_SPTR: initialize in class constructor
• Update vcc.json IsResultThrowException to IsActionResultThrowException
• vcc.json supports ActionHistoryType
• Add tag vccconfig so that setting in project is controlled by vcc.json
• Support GETCUSTOM, SETCUSTOM, GETCUSTOM_SPTR, SETCUSTOM_SPTR
• Support GETSET_VALIDATE, GETSET_VALIDATE_SPTR_NULL, VECTOR_VALIDATE, VECTOR_VALIDATE_SPTR, MAP_VALIDATE, MAP_VALIDATE_SPTR_R, ORDERED_MAP_VALIDATE, ORDERED_MAP_VALIDATE_SPTR_R
• Support one enum with multi class macro
• Class Enum supports @@Include @@Private @@Protected
• Class Property Enum supports @@Initialize
• Review usage of const

[v0.3.5] - 2025-05-05: Review - vcc.json Grouping

• Group vcc.json

[v0.3.4] - 2025-04-21: Review - Action Return OperationResult

• Action support return Result - Add Class tag @@Result and Field tag @@Result
• Add OperationResult to return Error Code and Message (Also auto generate at Java Project)

[v0.3.3] - 2025-03-30: Review - Action Argument

• Review folder and file naming rules. C++ folder must be lowercase without any seperator and file must be lower case with seperator. Java folder must be lowercase without any seperator and file must be having same name as class name
• Action: add macro ACTION_WITH_ARG and ACTION_WITH_ARG_SPTR to handle argument instead of tag @@Class
• Rename all c++ folder to lowercase

[v0.3.2] - 2025-03-01: Review - Initialize Git Manager

• Git Review
• Add vpm.config.json. Default location is ~/Documents/vcc/config
• Exception Macro add VALIDATE
• Add field attribute @@NoJson

[v0.3.1] - 2025-02-08: Review - Review Function Name

• Review helper function naming
• Seperate Remove and RemoveObject (function using void * as argument will remove object property and shift pointer. i.e. cannot find object from vector)
• Add ObjectId to IObject for idenitity checking. (Cannot find object from vector as pointer is shifted 8 for some cases)

[v0.3.0] - 2025-01-26: Review - Review Property Accessor

• Class macro VECTOR, VECTOR_SPTR add Remove method
• Remove memory_macro.hpp
• Review Class Macro and Property Accessor.
  • add AtIndex and AtKey for Vector, Map and Ordered Map. (Compiler cannot distinguish when Ordered Map having int key)
  • Property Accessor Seperate Read, Write, Remove, Clone to Read, ReadAtIndex, ReadAtKey, Write, WriteAtIndex, WriteAtKey, RemoveAtIndex, RemoveAtKey, CloneAtIndex, CloneAtKey. (Compiler cannot distinguish pointer and integer)

[v0.2.6] - 2025-01-05: Form - Action

• Support @@Thread
• @@Log, @@Action, @@Thread use IsIndependent insead of IsInheritFromParent
• Support Class Macro ACTION, MANAGER_SPTR, MANAGER_SPTR_NULL, MANAGER_SPTR_PARENT
• Add InitializeComponent(), OnInitialzieComponent(), InitialzeValues() and OnInitializeValues()
• Remove Java Form Initialize() and Reload(). Use should use Action to initalize or reload
• Initialzie Action

[v0.2.5] - 2024-12-08: Form - Generate Java Form

• Form Action - Create, Reload, Close
• Remove BaseObject template (No method to convert IObject and IForm if there is template)
• Fix cannot throw exception when excuting release exe
• Generator Support Action
• Review VCC Tag
• Class Attributes support @@Log and @@Action
• Remove ManagerType and ActionType

[v0.2.4] - 2024-11-13: Form - Generate Form

• Initialize Form
• Generate Form
• Fix vcc tag using wrong Key "SKIP" instead of "RESERVE"

[v0.2.3] - 2024-10-20: Form - Generate Inherit Class

• Initialize Application
• Generate Inherit Class
• Rename LogProperty to LogConfig as class suffix and Property and file suffix _property.hpp are reserved
• Merge IProperty and BaseProperty to IObject and BaseObject. Remove i_property.hpp and base_property.hpp
• Support Generate Form and inerted Class from Type Workspace in vcc.json
• Fix Win Version Generator not work

[v0.2.2] - 2024-10-12: Form - Urgent Fix

• Fix Generator not work

[v0.2.1] - 2024-10-12: Form - Initialize Thread

• Rename VCCModule Folder to Camel Case to fit java naming style
• VCCProjectGenerator Generation mode update Makefile according to vcc.json
• Drop and Create template in Document/VCC folder if VCCProjectGenerator version not match with template instead of Git Pull
• Remove file form_type.hpp, merge FormType to ObjectType

[v0.2.0] - 2024-10-03: Form - Initialize Thread

• Initialize Thread, ThreadService, ThreadManager
• LogService add LogDebug and LogThread
• ActionType, ExceptionType, FormType, ManagerType, ObjectType add custom tag

[v0.1.5] - 2024-09-17: Java Bridge: Generation - Auto Create Java Class and Enum according

• Use void * instead of ITypeUnion for Property Accessor Map Key.
• Generate Java Class according to C++ Enum Class under Type Workspace.
• Update vcc.json and Makefile to export dll, exe to Java project
• Update vcc.json TemplateWorkspace use ${userHome} instead of hardcode.
• Auto copy dll / exe to Java Project
• Fix Update Mode not working because of using // <vcc:exceptionType action:"RESERVE"> in exception_type.hpp instead of // <vcc:exceptionType action="RESERVE">

[v0.1.4] - 2024-08-25: Java Bridge: Generation - Java Bridege for Enum

• Generate Java Enum according to C++ Enum Class under Type Workspace.

[v0.1.3] - 2024-07-28: Generation - Dll Interface for Property Accessor

• Remove support of std::string, all change to use std::wstring
• Generate Dll Interface for Property Accessor
• vcc.json remove WorkspaceDestination, change WorkspaceSourceGitUrl to TemplateGitUrl, WorkspaceSource to TemplateWorkspace Note: Generation mode need to change WorkspaceDestination if using different PC.

[v0.1.2] - 2024-07-14: Java Bridge: Generation - Create Class as Json Object with

• Update Generator: Create Table as Json Object

[v0.1.1] - 2024-07-08: Java Bridge: Self Writing

• Fix Win Compile
• Update Generator be Self-writting project

[v0.1.0] - 2024-07-07: Java Bridge: Prepare for generate Java Bridge

• Makefile MacOS extension changed from .so to .dylib
• vcc.json rename ModelDirectory to ObjectDirectory, ObjectDirectory to ObjectDirectoryHpp, added ObjectDirectoryCpp
• Object Factory, Property Accessor Factory
• Generate Class Object with Json Serialize and Deserialize

[v0.0.5] - 2024-06-02: Basic Strucute: Property Accessor and Thread safe

• Generate Mode supports generate Property Accessor ReadWrite, ReadOnly, WriteOnly, NoAccess
• Class Macro remote STATIC_GET and GET, all class properties must support Get Set and the access mode is controlled by Property Accessor
• Generator support Map (Property Accessor cannot read key list )

[v0.0.4] - 2024-05-19: Basic Strucute: Merge XML and Improve Try Catch

• Add make unittest in Makefile
• Initial Property Accessor
• Merge XML Reader to XML Builder
• Improve TRY CATCH macro

[v0.0.3] 2024-05-06: Basic Strucute: Update project according to vcc.json

• Move vcc.json to .vcc/vcc.json
• Update Makefile to fix unittest name
• Trigger Update VCC Module will update Makefile according to vcc.json

[v0.0.2] 2024-05-05: Basic Strucute: Urgent Fix

• Fix cannot reexecute after switched to tag

[v0.0.1] 2024-05-05: Basic Strucute: Initialize

• Initialize