Skip to content

cpp2c.config.md

Latest commit

 

History

History
233 lines (191 loc) · 4.61 KB

cpp2c.config.md

File metadata and controls

233 lines (191 loc) · 4.61 KB
Raw

Configuration

This is an entry-by-entry specification generated from BGCS.Cpp2C.Configuration.Tests.

AdditionalArguments

1. Explanation

AdditionalArguments controls the AdditionalArguments behavior and is validated by both property snapshots and generated-output checks.

2. Type, Example, and Default Value

  • Type: List<string>
  • Default value: []
  • Example expected value: ["-DFROM_ADDITIONAL_ARGUMENTS=1"]

3. Example Config and Generated Output

Example config

{
  "NamePrefix": "Args_",
  "AdditionalArguments": [
    "-DFROM_ADDITIONAL_ARGUMENTS=1"
  ]
}

Example generated output markers

// Contains
typedef struct Args_Counter Args_Counter;
Args_Counter_Add
#define Args_API(type)
// NotContains

BaseConfig

1. Explanation

BaseConfig is validated through composition behavior, and tests assert the final NamePrefix after BaseConfig is applied.

2. Type, Example, and Default Value

  • Type: BaseConfig?
  • Default value: null
  • Example expected value: "Base_"

3. Example Config and Generated Output

Example config

{
  "BaseConfig": {
    "Url": "file://./base.json"
  }
}

Example generated output markers

// Contains
Base_Counter_Add
BaseMode_A
#define Base_API(type)
// NotContains

CppLogLevel

1. Explanation

CppLogLevel controls the CppLogLevel behavior and is validated by both property snapshots and generated-output checks.

2. Type, Example, and Default Value

  • Type: LogSeverity
  • Default value: LogSeverity.Error
  • Example expected value: "Warning"

3. Example Config and Generated Output

Example config

{
  "NamePrefix": "CppLog_",
  "CppLogLevel": "Warning"
}

Example generated output markers

// Contains
CppLog_Counter_Add
typedef enum
Mode_A = 1
// NotContains

Defines

1. Explanation

Defines controls the Defines behavior and is validated by both property snapshots and generated-output checks.

2. Type, Example, and Default Value

  • Type: List<string>
  • Default value: []
  • Example expected value: ["FROM_DEFINES=1"]

3. Example Config and Generated Output

Example config

{
  "NamePrefix": "Def_",
  "Defines": [
    "FROM_DEFINES=1"
  ]
}

Example generated output markers

// Contains
Def_Counter_Add
typedef struct Def_Counter Def_Counter;
// NotContains

IncludeFolders

1. Explanation

IncludeFolders controls the IncludeFolders behavior and is validated by both property snapshots and generated-output checks.

2. Type, Example, and Default Value

  • Type: List<string>
  • Default value: []
  • Example expected value: ["includes"]

3. Example Config and Generated Output

Example config

{
  "NamePrefix": "Inc_",
  "IncludeFolders": [
    "includes"
  ]
}

Example generated output markers

// Contains
DepMode_A = 1
Inc_Counter_Add
// NotContains

LogLevel

1. Explanation

LogLevel controls the LogLevel behavior and is validated by both property snapshots and generated-output checks.

2. Type, Example, and Default Value

  • Type: LogSeverity
  • Default value: LogSeverity.Warning
  • Example expected value: "Information"

3. Example Config and Generated Output

Example config

{
  "NamePrefix": "Log_",
  "LogLevel": "Information"
}

Example generated output markers

// Contains
Log_Counter_Add
Mode_A = 1
// NotContains

NamePrefix

1. Explanation

NamePrefix controls the NamePrefix behavior and is validated by both property snapshots and generated-output checks.

2. Type, Example, and Default Value

  • Type: string
  • Default value: string.Empty
  • Example expected value: "Wrapped_"

3. Example Config and Generated Output

Example config

{
  "NamePrefix": "Wrapped_"
}

Example generated output markers

// Contains
typedef struct Wrapped_Counter Wrapped_Counter;
Wrapped_Counter_Add
#define Wrapped_API(type)
// NotContains

SystemIncludeFolders

1. Explanation

SystemIncludeFolders controls the SystemIncludeFolders behavior and is validated by both property snapshots and generated-output checks.

2. Type, Example, and Default Value

  • Type: List<string>
  • Default value: []
  • Example expected value: ["sysincludes"]

3. Example Config and Generated Output

Example config

{
  "NamePrefix": "Sys_",
  "SystemIncludeFolders": [
    "sysincludes"
  ]
}

Example generated output markers

// Contains
typedef struct Sys_Counter Sys_Counter;
Sys_Counter_Add
#define Sys_API(type)
// NotContains