Skip to content

we4c-ai/python-flowChart

BranchesTags

Repository files navigation

python-flowChart

version a1.1 (alpha 1.2)

Python program for creating flowchart from source code. Program was developed with purpose to sync source code with documentation for work purpose.

This program uses reference comments inside source code to generate flow chart.

To do

Create better alignment of nodes. I will change program gradually. Please see milestones for improvements.

When (if) number of users start increasing, I will change milestones, commit comments and issues to English. For now, I will be using Slovene.

How to use

What do I need?

To use this python program, you will need the following SW packages:

  • Graphviz (I'm using Windows 10 for development and test)
  • Make sure you have it in environment variable. If you run from CMD or terminal, command dot should be callable.
  • If it isn't executed, add variable. For Windows, the path should be "C:\Program Files (x86)\Graphviz2.38\bin" if you install in default directory.
  • Python (I'm using Anaconda Python 3.7 for development and test)
  • Pthon packages:

How to use?

  • Clone or download repository.
  • Put reference comments in your source code (see chapter Reference comments)
  • Use command line input

CLI support

usage: flowchart.py [-h] -s SOURCE -d DEST [-j] [-v] [--func FUNCS] -l LANG

optional arguments:
  -h, --help            show this help message and exit
  -s SOURCE             Absolute or relative path to source code file.
  -d DEST               Absolute or relative path to destination folder.
  -j, --jaconv          If set, jaconv (for Japanese) will be used.
  -v, --view            If set, preview will be enabled.
  --func FUNCS          With this argument you can create graph for only
                        specified functions in source code
  -l LANG, --lang LANG  With this argument you define programming language you
                        are using.

Example

The following line will export every function from testCode.c as separate PDF files in OutputFolder. We use path relative to flowchart.py. python flowchart.py -s src/testCode.c -d OutputFolder

The following line will export only functions foo1 and foo2 from testCode.c as separate PDF files in OutputFolder. We use path relative to flowchart.py. python flowchart.py -s src/testCode.c -d OutputFolder --func foo1 --func foo2

Warning

  • Code was tested on embedded C source code.
  • Program uses graphviz for generating flow chart diagram.
  • Currently program generates correct flow of data, but alignment is sometimes hard to read (will try to fix this).
  • Currently program generates only PDF file. "Paper size" is as big as it needs to be (will try to fix this).

Daido graph

Daido graph if one sort of flow chart diagrams. The company I worked for used this style of flow chart. It is pretty good for C language, for object-orientaded languages might not work so good.

These are elements representing the diagram:

  • Start and stop of function
  • Process
  • If branch
  • For loop (in the future any loop)
  • Sub function
  • Sub routine
  • Middleware

Reference comments

Reference comments are used to create flow chart diagram based on source code. To generate proper diagram, the following syntax of reference comment must be used.

fc:<block_name> string_without_space "string with space"

For <block_name> use one of the comments from List of reference comments.
After <block_name> you can place two strings. If string is separated with space, it will be moved to new line in diagram block. To avoid that, use " for strings with space.

Examples:

fc:<block_name> short string will be displayed as

short
string

fc:<block_name> "short string" will be displayed as

short string

fc:<block_name> string will be displayed as

string

fc:<block_name> "upper level" "lower level" will be displayed as

upper level
lower level

There is also a limit how many strings can go into 1 row. The limit is 24 half-width characters or 12 full-width characters. Actually, you can input more, but text will go out of borders.

this is half-width
ｔｈｉｓ　ｉｓ　ｆｕｌｌーｗｉｄｔｈ
ﾊﾝｶｸ
全角

List of reference comments

Currently supported are the following comments:

  • fc:startStop
  • fc:process
  • fc:ifBranch
  • fc:else
  • fc:forLoop
  • fc:end
  • fc:subFunc
  • fc:subRoutine
  • fc:middleware

How to use reference comments

fc:startStop

This comment represents start and stop of the function.
File name will be taken by this comment. If you put space between words, newline will be show in diagram, but in file name space " " will be replaced by uderline "_".

void func(){  //fc:startStop func
...
...
}  //fc:startStop return

fc:process

This comment represents process line of code.

int a = 5;  //fc:process "init var a" "with 5"

some_var = new_val;  //fc:process "append new_val" "to some_var"

fc:ifBranch

This comment represents beginning of if sentence.

if(a > 5){  //fc:ifBranch "is a > 5 ?"
  ...
}

fc:else

This comment represents beginning of else part of if sentence.

if(a > 5){  //fc:ifBranch "is a > 5 ?"
  ...
}
else{  //fc:else
  ...
}  //fc:end

fc:forLoop

This comment represents beginning of for loop. It can be also used for other loops.
Name will change in the future to "loop".

for(int i = 0; i < 10; i++){  //fc:forLoop "loop 10 times"
  ...
}  //fc:end

fc:end

This comment represents end of if sentence and end of for loop. It can be also used for other loops.
Always place fc:end at the end of loops and ifs.

for(int i = 0; i < 10; i++){  //fc:forLoop "loop 10 times"
  ...
}  //fc:end

fc:subFunc

This comment represents call of a sub function. It is based on user's code and opinion to decide which function is main an which is sub.

void func(){
  int a = 5;
  longCode();  //fc:subFunc long_code longCode()
  a = 3;
}

fc:subRoutine

This comment represents call of a sub routine. It is based on user's code and opinion to decide which function is sub routine.

void func(){
  int a = 5;
  executeRepetitiveCode();  //fc:subFunc repetitive_code executeRepetitiveCode()
  a = 3;
}

fc:middleware

This comment represents call of a middleware function. It is based on user's code and opinion to decide which function is middleware.

void func(){
  int a = 5;
  a = myMiddleware();  //fc:subFunc middleware myMiddleware()
}

Example

Source code

static void init400m(void){//fc:startStop init400m
  /***	ローカル変数		***/
	
  /***	処理開始			***/
  if(kpinfwt.rstinf == ON){					/*	fc:ifBranch 危険側故障　立上げ抑止あり */
      if((systeminwt.sysin_fix & MAINTE_SW) == MAINTE_SW){
                                            /*	fc:ifBranch 保守SW扱い中? */
          mdl_mramprt_reset(TSK_INIT, CID_79, (UH *)&kpinfwt.rstinf);
                                            /*	fc:middleware MRAMプロテクト解除 mdl_mramprt_set */
          kpinfwt.rstinf = OFF;				/*	fc:process 立上げ抑止クリア */
          mdl_mramprt_set(TSK_INIT, CID_78, (UH *)&kpinfwt.rstinf);
                                            /*	fc:middleware MRAMプロテクト設定 mdl_mramprt_set */
          systemoutwt.iokgr_ctl = ON;			/*	fc:process IOKGR扛上制御設定 */
      }else{//fc:else
          systemoutwt.iokgr_ctl = OFF;		/*	fc:process IOKGR落下制御設定 */
          l_cpusdnstop(TSK_INIT, ERRID_CM_N17, NULL, 0u, RSTCTLON);
                                            /*	fc:middleware "CPU 即時停止" l_cpusdnstop */
      }//fc:end
  }else{//fc:else
      systemoutwt.iokgr_ctl = ON;				/*	fc:process IOKGR "扛上制御設定" */
  }//fc:end
}//fc:startStop break

Generated flow chart

About

Python program for creating flowchart from source code

Resources

Readme

License

GPL-3.0 license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

3 tags

Packages

No packages published

Languages