CGA_RDL


   _____ _____            _____  _____  _
  / ____/ ____|   /\     |  __ \|  __ \| |
 | |   | |  __   /  \    | |__) | |  | | |
 | |   | | |_ | / /\ \   |  _  /| |  | | |
 | |___| |__| |/ ____ \  | | \ \| |__| | |____
  \_____\_____/_/    \_\ |_|  \_\_____/|______|
                     ______
                    |______|

RDL

Replacement Definition Language
Reduce the wasting time for tedious repetitive works

Explanation

Description of Syntax (2_replace.pl)

This is replacement tool with special syntax.
- ITERATE %Hash +<<+ .... +>>+
- IFEQUAL(A eq B)+{{+ .... +}}+
- +<+ .... +>+

Special case of use +<+ .... +>+

we can add perl expression in +<+ .. +>+
- ex) +<+ uc($fish) +>+ : convert $ fish to upper characters
add " " to use string as a key of hash in condition of IFEQUAL
- ex) IFEQUAL("ITKEY" eq +<+ $fish{"IT2KEY"} +>+

Control and Programming in RDL

for make index of sequencial count
- ex) test.cpp.stc
- make test

ITERATE %MODULE +<<+ ITKEY  ITVALUE
    ITKEY // +<+$g_y = 0+>+             <-- this is not a program so it will be comments. $ g_y = 0
    +<+$g_y+>+                          <-- print the value
    // set +<+ $g_y=plus($g_y,1) +>+        <-- comments : increment $g_y   +<> are special characters, so I support plus function instead of +
    ITERATE %MODULE{ITKEY} +<<+ IT2KEY  IT2VALUE
        IT2KEY
        x1 : +<+$MODULE{"ITKEY"}{"IT2KEY"}{x1}+>+
        IFNOTEQUAL(+<+$MODULE{"ITKEY"}{"IT2KEY"}{x1}+>+ < 5)+{{+
            not under 5 : duration type 1: +<+$MODULE{ITKEY}{IT2KEY}{duration}+>+    => +<+$g_y+>+ // set +<+ $g_y=plus($g_y,1) +>+     <-- print variable and increment the variable
            not under 5 :  duration type 2: +<+$MODULE{"ITKEY"}{IT2KEY}{duration}+>+     => +<+$g_y+>+ // set +<+$g_y=plus($g_y,1)+>+
            not under 5 :  duration type 3: +<+$MODULE{"ITKEY"}{"IT2KEY"}{duration}+>+   => +<+$g_y+>+ // set +<+$g_y=plus($g_y,1)+>+
            not under 5 :  x1 +<+$MODULE{"ITKEY"}{"IT2KEY"}{x1}+>+
        +}}+
        IFEQUAL(+<+$MODULE{"ITKEY"}{"IT2KEY"}{x1}+>+ > 3)+{{+
            duration type 1: +<+$MODULE{ITKEY}{IT2KEY}{duration}+>+    => +<+$g_y+>+ // set +<+ $g_y=plus($g_y,1) +>+
            duration type 2: +<+$MODULE{"ITKEY"}{IT2KEY}{duration}+>+     => +<+$g_y+>+ // set +<+$g_y=plus($g_y,1)+>+
            duration type 3: +<+$MODULE{"ITKEY"}{"IT2KEY"}{duration}+>+   => +<+$g_y+>+ // set +<+$g_y=plus($g_y,1)+>+
            x1 +<+$MODULE{"ITKEY"}{"IT2KEY"}{x1}+>+
        +}}+
        y1 +<+$MODULE{ITKEY}{IT2KEY}{y1}+>+         cnt : +<+$g_y+>+
        Remark +<+$MODULE{ITKEY}{IT2KEY}{Remark}+>+

    +>>+
+>>+

recover (3_recover.sh 3_recover.pl)

3_recover.pl (make 3)
- Each file has unique key each file to use merge function.
- Rule : CGA_VARIANT_START to CGA_VARIANT___END
  - Basic Rule : START ~ END
    - START syntax : if($in =~ /^\s*[\/\*\#]*\s*\@CGA_VARIANT_START\{[\"]?([^"}]*)[\"]?\}\s*$/)
    - END syntax : if($in =~ /^\s*[\/\*\#]*\s*\@CGA_VARIANT___END\{[\"]?([^"}]*)[\"]?\}\s*$/)
  - code area in *.cpp / h file
    - // @CGA_VARIANT_START{"TIDLManagerService:TIDL_COMMON_API_3"}
    - // @CGA_VARIANT___END{"TIDLManagerService:TIDL_COMMON_API_3"}
  - comments area in *.cpp / h file
    - * @CGA_VARIANT_START{"DOXYGEN:TIDLManagerService::TIDL_COMMON_API_6()_SRS"}
    - * @CGA_VARIANT___END{"DOXYGEN:TIDLManagerService::TIDL_COMMON_API_6()_SRS"}
  - code area in *.sh file
    - # @CGA_VARIANT_START{"tidl_api_test_shell"}
    - # @CGA_VARIANT___END{"tidl_api_test_shell"}
- run 3_recover.pl
  - perl 3_recover.pl --template=./OUTPUT/stc/src/2_example.cpp --working=./3_working.cpp.data --merge=./c/d/a.cpp
3_recover.sh (make test_recover)
- use when you have many files in several directories.
- arguments
  - $1 : TEMPLATE BASE DIRECTORY (OUTPUT/stc)
  - $2 : WORKING BASE DIRECTORY (test_recover/working)
  - $3 : MERGED BASE DIRECTORY (test_recover/merged)
- ex) sh 3_recover.sh OUTPUT/stc test_recover/working test_recover/merged
  - $ 3_recover.sh [template based generated dir] [working(modified) base dir] [merged(output) dir]
  - when we add template , our merged directory will have result file from template.
  - if some files exist in working dir only , they will be copied into merged(output) dir.
  - finally merged(output) dir will have all files both working(modified) directory and template based generated directory.
when you show difference between two directories
- $ diff -r A_directory B_directory
- use merge tool (beyond compare or arxis merge) to compare

Purpose

Reduce the wasting time for tedious repetitive works
- Generally we have a lot of tedious repetitive job. So in case of android , android supports to make a AIDL (Android Interface Definition Language) to make binder bn,bp services. So we can use easily with this template. But , it is just for android application.
- I wanna make a tool for more general purpose. So We will support simple definition. The simple definitions are Loop and Condition and Replacement's statements.
example
- repeted works (iteration) of cases in switch
- repeted works (iteration) of functions
- repeted works (iteration) of if ... elseif ... else ...
- repeted works (iteration) of lists

Environment

install perl module (cpan)
library MY::CHARLES in perllib directory

use csv file instead of excel

Excel is more convenient and effective. But , you can use csv file with 1_csv.pl if you have some problem to install perl package.
perl 1_csv.pl --input=./time/Code_Generator.csv --csv_out=./time/o.csv
- you can run with csv file instead of xlsx file.
- First of all , you convert the file into csv file when you have error of perl package for excel.
- if you use MAC OSX , your csv file will have as one line with ^M. so you can replace ^M with \r\n

read excel

https://perlmaven.com/read-an-excel-file-in-perl

Install

perl module install

cpan
- install Spreadsheet::Read
  - When I run read.pl , I meet the following msg “Parser for XLSX is not installed at read.pl line 9.”
- install Spreadsheet::XLSX

How to run the test

example1 (test)

cd CGA_RDL
make test
- Description
  - 1_excel.pl -> generate default.GV (perl hash database) from excel file input : test.xlsx (EXCEL) output : default.GV
  - 2_replace.pl -> generate OUTPUT/stc/* (template file) from stc extension file with default.GV(perl hash database) input : default.GV , test.cpp.stc output : OUTPUT/stc/test.cpp

example2 (stc)

cd CGA_RDL
make
- Description
  - 1_excel.pl -> generate default.GV (perl hash database) from excel file
    - perl 1_excel.pl --input=1_example.xlsx --csv_output=1_example.csv --version_input=./excel_version
      - input : 1_example.xlsx (EXCEL)
      - output csv file : 1_example.csv <- this file will be used to compare as text and use as backup.
      - excel_verion check : compare between [VARIABLE]Excel_Version in excel and contents in excel_version file.
        
        generally we should synchonize between excel version and current git repository version.
        
        if you do not need to check version, remove --version_input option.
      - output : default.GV
  - 2_replace.pl -> generate OUTPUT/stc/* (template file) from stc extension file with default.GV(perl hash database) input : default.GV , 2_example.cpp.stc output : OUTPUT/stc/2_example.cpp
  - 3_recover.pl -> merge working file from template file input : OUTPUT/stc/2_example.cpp , 3_working.cpp.data output : 3_merge.cpp
- result : OUTPUT/stc/* and 3_merge.cpp

example3 (stcI)

cd CGA_RDL/test/DIAG
make
- Description
  - 1_excel.pl -> generate default.GV (perl hash database) from excel file input : diag.xlsx (EXCEL) output : default.GV
  - 2_replace.pl -> generate OUTPUT/stc/* (template file) from stc extension file with default.GV(perl hash database)
    - stc : Stencil Template C/Cpp
    - stcI : Stencil Template C/Cpp Iterator -> make multiple file from stcI file input : default.GV , *.stc , .stcI output : OUTPUT/stc/
- result : OUTPUT/stc/*

Process

Excel ---(1_exce.pl)---> Hash Data -----+
_________________________stc(I) File ---+--(2_replace.pl)---> output c/cpp files

Data	Execute	Data	Execute	Data
Excel	-(1_exce.pl)->	Hash Data
		stc(I) File	-(2_replace.pl)->	output c/cpp files

This is plantuml. You can see plantuml through editor vscode or atom with Markdown-Preview_Enhanced Module.
- install vscode or atom
- install java
- install graphviz

@startuml
folder Update {
  artifact Excel
}

folder STC {
    artifact template.stc
    artifact template.stcI
}

folder Template {
    artifact Template.hpp
    artifact Template.CPP
    artifact Template.etc
}

database Hash_Data [
Hash DataBase from 1_excel
]

Update -down-> 1_excel.pl
1_excel.pl -down-> Hash_Data
STC -down-> 2_replace.pl
Hash_Data -down-> 2_replace.pl
2_replace.pl -down-> Template
@enduml

If you want to reuse your works after changing your excel file ,
- Update Excel ---(1_exce.pl)---> Hash Data -----+
- ________________________________stc(I) File ---+--(2_replace.pl)---> Updated output c/cpp file ---+
- __________________________________________________________Worked(Changed) file from c/cpp file ---+--(3_recover.pl)---> Merged file

Data	Execute	Data	Execute	Data	Execute	Data
Update Excel	-(1_exce.pl)->	Hash Data
		stc(I) File	-(2_replace.pl)->	Updated output c/cpp files
				Worked(Changed) file from c/cpp files	-(3_recover.pl)->	Merged file

@startuml
folder Update {
  artifact Excel
}

folder STC {
    artifact template.stc
    artifact template.stcI
}

folder Template {
    artifact Template.hpp
    artifact Template.CPP
    artifact Template.etc
}

database Hash_Data [
Hash DataBase from 1_excel
]

folder Changed {
    artifact working.hpp
    artifact working.CPP
    artifact working.etc
}

folder Merge {
    artifact Merged.hpp
    artifact Merged.CPP
    artifact Merged.etc
}


Update -down-> 1_excel.pl
1_excel.pl -down-> Hash_Data
STC -down-> 2_replace.pl
Hash_Data -down-> 2_replace.pl
2_replace.pl -down-> Template
Template -down-> 3_recover.pl
Changed -down-> 3_recover.pl
3_recover.pl -down-> Merge
@enduml

Relationship between each processes (excel & database & stc file )

The Headers in excel are related to variable name in stc file.

Explanation of Example 1 (1_example.xlsx)

Excel

Header starts with "[HEADER]"
Excel file
- [Header]MODULENAME
  - You can use MODULENAME name as variable name in stc/stcI file
- example of excel

[HEADER]Related_Manager	VALUE
vif	O
audio	X

$Related_Manager{vif}{Related_Manager} = vif
$Related_Manager{vif}{VALUE} = O
$Related_Manager{audio}{Related_Manager} = audio
$Related_Manager{audio}{VALUE} = X

DataBase

default.GV

  $Related_Manager{vif}{Related_Manager} = vif
  $Related_Manager{vif}{VALUE} = O
  $Related_Manager{audio}{Related_Manager} = audio
  $Related_Manager{audio}{VALUE} = X

stc or stcI 's replacement

stc

ITERATE %Related_Manager +<<+ ITKEY  ITVALUE
IFEQUAL(+<+$Related_Manager{ITKEY}{VALUE}+>+  eq "O")+{{+
/*!! ITKEY Inheritance CGA start-------------------------------------------------*/
    m+<+ucfirst("ITKEY")+>+Manager = NULL;
    m+<+ucfirst("ITKEY")+>+Receiver = NULL;
    m+<+ucfirst("ITKEY")+>+PostReceiver = NULL;
/*!! ITKEY Inheritance CGA end-------------------------------------------------*/
+}}+
+>>+

ITKEY in ITERATE statements
- vif and audio in Related_Manager
+<+$Related_Manager{ITKEY}{VALUE}+>+ will be replaced with O or X
- $Related_Manager{vif}{VALUE} = O
- $Related_Manager{audio}{VALUE} = X
IFEQUAL(A eq B)+{{+ ...... +}}+
- if A equals B , print .... in output file

Enhanced Example 2 with multiple [HEADER] for multi-dimension

Excel

Header starts with "[HEADER]"
Excel file
- example of excel

[HEADER]MODULE	[HEADER]DPID	duration	x1	y1
telltale	LEFT	70	50	100
telltale	RIGHT	500	4	40
vif	CAN	700	7	70

    $MODULE{telltale}{LEFT}{MODULE} = telltale
    $MODULE{telltale}{LEFT}{DPID} = LEFT
    $MODULE{telltale}{LEFT}{duration} = 70
    $MODULE{telltale}{LEFT}{x1} = 50
    $MODULE{telltale}{LEFT}{y1} = 100
    $MODULE{telltale}{RIGHT}{MODULE} = telltale
    $MODULE{telltale}{RIGHT}{DPID} = RIGHT
    $MODULE{telltale}{RIGHT}{duration} = 500
    $MODULE{telltale}{RIGHT}{x1} = 4
    $MODULE{telltale}{RIGHT}{y1} = 40
    $MODULE{vif}{CAN}{MODULE} = vif
    $MODULE{vif}{CAN}{DPID} = CAN
    $MODULE{vif}{CAN}{duration} = 700
    $MODULE{vif}{CAN}{x1} = 7
    $MODULE{vif}{CAN}{y1} = 70

DataBase

default.GV

    $MODULE{telltale}{LEFT}{MODULE} = telltale
    $MODULE{telltale}{LEFT}{DPID} = LEFT
    $MODULE{telltale}{LEFT}{duration} = 70
    $MODULE{telltale}{LEFT}{x1} = 50
    $MODULE{telltale}{LEFT}{y1} = 100
    $MODULE{telltale}{RIGHT}{MODULE} = telltale
    $MODULE{telltale}{RIGHT}{DPID} = RIGHT
    $MODULE{telltale}{RIGHT}{duration} = 500
    $MODULE{telltale}{RIGHT}{x1} = 4
    $MODULE{telltale}{RIGHT}{y1} = 40
    $MODULE{vif}{CAN}{MODULE} = vif
    $MODULE{vif}{CAN}{DPID} = CAN
    $MODULE{vif}{CAN}{duration} = 700
    $MODULE{vif}{CAN}{x1} = 7
    $MODULE{vif}{CAN}{y1} = 70

stc (test.cpp.stc)

ITERATE %MODULE +<<+ ITKEY  ITVALUE
    ITKEY ->
    ITERATE %MODULE{ITKEY} +<<+ IT2KEY  IT2VALUE
        IT2KEY
    +>>+

+>>+

OUTPUT/stc/test.cpp

  telltale ->
    LEFT
    RIGHT
  vif ->
    CAN

Syntax and Explanation of RDL

stc
- FileName : DiagInputManager.cpp -> generate file name in ./OUTPUT/stc
- FileName : src/DiagInputManager.cpp -> generate file name in ./OUTPUT/stc/src
- FileName : ../DiagInputManager.cpp -> generate file name in ./OUTPUT/
- FileName : /tmp/DiagInputManager.cpp -> generate file name in /tmp
stcI
- stcI_HASH : PPP -> generate multiple files from hash PPP (PPP is Header name in excel file.)
  - generated multiple file in example -> ???type???.??? , ???length???.???
- stcI_FILEBODY = "YES" or "NO" : default => YES , + is concatenation
  - if stcI_FILEBODY is YES , file name is made by following order : stcI_FILEPREFIX + KEY + stcI_FILEPOSTFIX . stcI_EXTENTION
  - if stcI_FILEBODY is NO , file name is made by following order : stcI_FILEPREFIX + stcI_FILEPOSTFIX . stcI_EXTENTION
- stcI_FILE_LOWER = "NO" or "YES" : default => NO , + is concatenation
  - if stcI_FILEBODY is YES (default) && stcI_FILE_LOWER is YES , file name is made by following order : stcI_FILEPREFIX + lc(KEY) + stcI_FILEPOSTFIX . stcI_EXTENTION
    - lc(KEY) means lower characters.
- stcI_ALL_LOWER = "NO" or "YES" : default => NO , + is concatenation
  - if stcI_ALL_LOWER is YES , all file name is made by following order : lc(stcI_FILEPREFIX + KEY + stcI_FILEPOSTFIX . stcI_EXTENTION)
    - lc(...) means lower characters.
- stcI_EXTENSION : cpp
  - generated multiple file in example -> ???type???.cpp , ???length???.cpp
- stcI_FILEPREFIX : I
  - generated multiple file in example -> Itype???.cpp , Ilength???.cpp
  - use +<+...+>+ (replacement syntax) (ex. KEY=Wifi)
    - stcI_FILEPREFIX:+<+lc(KEY)+>+I => wifiI
- stcI_FILEPOSTFIX : Manager
  - generated multiple file in example -> ItypeManager.cpp , IlengthManager.cpp
  - use +<+...+>+ (replacement syntax) (ex. KEY=Wifi)
    - stcI_FILEPOSTFIX:+<+uc(KEY)+>+man => WIFIman
- SetI : $MODULENAME = KEY
  - $MODULENAME=type in ItypeManaager.cpp
  - $MODULENAME=length in IlengthManaager.cpp
  - use +<+...+>+ (replacement syntax) (ex. KEY=Wifi)
    - SetI : $MODULENAME = +<+uc(KEY)+>+ => $MODULENAME = WIFI
- example 1 (test/DIAG/IXXXManagerService.h.stcI)
  - Module_Name has 2 keys : Diag and Antenna
    - stcI_HASH : Module_Name
    - stcI_EXTENSION : h
    - stcI_FILEPREFIX : TTT/I
    - stcI_FILEPOSTFIX : ManagerService
    - Set : $iterate_comments = OFF
    - SetI : $MODULENAME = KEY
  - output :
    - OUTPUT/stc/TTT/IDiagManagerService.h
    - OUTPUT/stc/TTT/IAntennaManagerService.h
- example 2 (test/DIAG/IXXXManagerService.cpp.stcI)
  - Module_Name has 2 keys : Diag and Antenna
    - stcI_HASH : Module_Name
    - stcI_EXTENSION : h
    - stcI_FILEPREFIX : TTTKEY/I
    - stcI_FILEPOSTFIX : ManagerService
    - Set : $iterate_comments = OFF
    - SetI : $MODULENAME = KEY
  - output :
    - OUTPUT/stc/TTTDiag/IDiagManagerService.h
    - OUTPUT/stc/TTTAntenna/IAntennaManagerService.h
common in stc and stcI
- Set : $iterateInputFileName = DiagInputManager.cpp -> use as variable. $ means variable.
  - +<+$iterateInputFileName+>+ replaces with "DiagInputManager.cpp".
- +<+$variable+>+ ... +<+ $hash{key} +>+
  - +<+ $variable +>+ means replacement with it.
  - you can use perl hash variable as a variable..
- IFEQUAL(+<+$Related_Manager{vif}{VALUE}+>+ eq "O")+{{+ ....... ...... +}}+
  - condition statement
  - if true , show ........
- ITERATE %hash +<<+ ITKEY ITVALUE ITKEY ITVALUE +>>+
  - iterator with hash variable
  - ITKEY is key of hash (keys %hash in perl)
  - ITVALUE is value of hash ($hash{key} in perl). But, we use +<+$hash{ITKEY}??+>+ instead of ITVALUE.

Collect the latest info each TIDL module

Collect the latest info
execute
- cd ./collect
- python3 collect_daae.python3
output
- Code_Generator.csv : new csv file
- Code_Generator_old.csv : old csv file (copy the last Code_Generator.csv)
- late_tidl.csv : changed content

convert csv to excel (csv2excel)

csv2excel - design

csv를 만들때 얼마의 단위로 만들 것인가? hpp 파일 하나의 단위인가? 아니면 hpp들을 모은 단위인가?
field (header) below the header 에 #insert(color)_의미 와 같은 것을 넣어 있다면 이런 처리를 가지고, csv로부터 xlsx를 만드는 것이다.
- #set_color(color) - bg_color: yellow , text_color : blue
- #set_width(size) - width : best , auto or 30 , 40 ..etc <- this is located in first line of csv
- #set_font(color) xxxxxxx
excel을 먼저 빨리 만들어서, code에서 사용하는 값들을 모두 나열해야 할 것으로 보인다.
csv2excel : source code

csv2excel - implementation

3 stage
- ===stage 1 : set_color set_width===
- ===stage 2 : HEADER VARIABLE font===
- ===stage 3 : HEADER no_data===
- add Makefile
Usage: csv2excel.py [options] -i inputfile(csv) -o outfile(xlsx) ''' Options: -h, --help show this help message and exit -i INFILENAME, --in=INFILENAME read data from csv FILENAME -o OUTFILENAME, --out=OUTFILENAME write data from excel FILENAME -d, --debug print debug message -v, --verbose '''
#set_width(auto),10,10,5,auto,10,auto,10,¶
- change the width of column
- auto is maximum size of the same column
- ex) auto , best , number(size)
"#(red)this is a single variable not hash. +<+$VARIABLE{""Date""}+>+",,,,,,,,,,,,,,,,,¶
- this is comments with color of font
"# (green) this is update time of header each file".,,,,,,,,,,,,,,,,,¶
- this is comments with color of font
#set_color(lightgreen),lightblue,lightgreen,lightblue,,,,lightgreen,lightblue,,,orange,
- change color of column
#set_color(lightgreen),orange,lightgreen,orange,,,,lightgreen,lightblue,,,orange,¶
- change color of column

sample.xlsx

Functions

MACRO

example
if you want to empty argument , you use like MACRO_WORD_EX(void).
- it does not support empty argument like MACRO_WORD_EX().
test : it includes error.

make macro

Multiple Line MACRO : __INLINEMACRO

- define

stcI_MACRO_START : MACRO_1ARG(TT,TV)
    TT is mine.
    TV is yours.
stcI_MACRO_END

- usage (example)

__INLINEMACRO MACRO_1ARG(ANY1, ANY2)

Single Line MACRO :

- word unit MACRO
- define

stcI_MACRO_WORD  : MACRO_WORD_EX(TT,TV)   33TT == 4TV

- usage (example)

sing line :  __INMACRO< MACRO_WORD_EX(stcI_empty,PP2) > is eample of single line macro.

Files

DOC.md

Latest commit

History

DOC.md

File metadata and controls

CGA_RDL

RDL

Explanation

Description of Syntax (2_replace.pl)

Special case of use +<+ .... +>+

Control and Programming in RDL

recover (3_recover.sh 3_recover.pl)

Purpose

Environment

use csv file instead of excel

read excel

Install

perl module install

How to run the test

example1 (test)

example2 (stc)

example3 (stcI)

Process

Relationship between each processes (excel & database & stc file )

Explanation of Example 1 (1_example.xlsx)

Excel

DataBase

stc or stcI 's replacement

Enhanced Example 2 with multiple [HEADER] for multi-dimension

Excel

DataBase

Syntax and Explanation of RDL

Collect the latest info each TIDL module

convert csv to excel (csv2excel)

csv2excel - design

csv2excel - implementation

sample.xlsx

Functions

MACRO

Multiple Line MACRO : __INLINEMACRO

Single Line MACRO :