Skip to content

Commit 2553413

Browse files
adriwebadriweb
committed
Initial version of the tested-functions-list generator
1 parent 399f990 commit 2553413

File tree

2 files changed

+307
-0
lines changed

2 files changed

+307
-0
lines changed

‎tools/funcs_tested/gen_list.sh

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
#!/bin/bash
2+
# Adrien 'Adriweb' Bertrand
3+
# Tool to generate a list of things that are used/tested in the toolchain example codes.
4+
# Dependencies: universal-ctags
5+
6+
set -e
7+
8+
# Grab current path
9+
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
10+
11+
# Let's go back to the root of the toolchain
12+
cd $DIR/../../
13+
14+
# All header files we want to extract prototypes from
15+
files="src/fileioc/fileioc.h src/graphx/graphx.h src/keypadc/keypadc.h src/ce/tice.h src/ce/decompress.h src/ce/debug.h"
16+
17+
# The destination markdown file
18+
outfile=$DIR/tested-functions-list.md
19+
20+
echo "## List of tested functions" > $outfile
21+
22+
for f in $files
23+
do
24+
echo -e "\n### $f" >> $outfile
25+
echo -e "| Function | Tested ? |" >> $outfile
26+
echo -e "| -------- | ----------- |" >> $outfile
27+
filectags=$(ctags -u --fields=n --c-kinds=p --output-format=json $f | sed -e 's/.*"name": "\(.*\)", "path.*/\1/g')
28+
for c in $filectags
29+
do
30+
grep -Rq --include \*.h --include \*.cpp --include \*.h --include \*.c "$c" ./examples && found="<span style='color:green'>✓</span>" || found="<span style='color:red'>✗</span>"
31+
echo "| \`$c\` | $found |" >> $outfile
32+
done
33+
done
34+
35+
cat $outfile

‎tools/funcs_tested/tested-functions-list.md

Lines changed: 272 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,272 @@
1+
## List of tested functions
2+
3+
### src/fileioc/fileioc.h
4+
| Function | Tested ? |
5+
| -------- | ----------- |
6+
| `ti_CloseAll` | <span style='color:green'>✓</span> |
7+
| `ti_Open` | <span style='color:green'>✓</span> |
8+
| `ti_OpenVar` | <span style='color:green'>✓</span> |
9+
| `ti_Close` | <span style='color:green'>✓</span> |
10+
| `ti_Detect` | <span style='color:green'>✓</span> |
11+
| `ti_DetectVar` | <span style='color:red'>✗</span> |
12+
| `ti_Write` | <span style='color:green'>✓</span> |
13+
| `ti_Read` | <span style='color:green'>✓</span> |
14+
| `ti_PutC` | <span style='color:red'>✗</span> |
15+
| `ti_GetC` | <span style='color:red'>✗</span> |
16+
| `ti_Seek` | <span style='color:red'>✗</span> |
17+
| `ti_Rewind` | <span style='color:green'>✓</span> |
18+
| `ti_Tell` | <span style='color:red'>✗</span> |
19+
| `ti_GetSize` | <span style='color:green'>✓</span> |
20+
| `ti_Resize` | <span style='color:red'>✗</span> |
21+
| `ti_IsArchived` | <span style='color:red'>✗</span> |
22+
| `ti_SetArchiveStatus` | <span style='color:red'>✗</span> |
23+
| `ti_Delete` | <span style='color:red'>✗</span> |
24+
| `ti_DeleteVar` | <span style='color:red'>✗</span> |
25+
| `ti_GetTokenString` | <span style='color:green'>✓</span> |
26+
| `ti_GetDataPtr` | <span style='color:green'>✓</span> |
27+
| `ti_SetVar` | <span style='color:green'>✓</span> |
28+
| `ti_StoVar` | <span style='color:red'>✗</span> |
29+
| `ti_RclVar` | <span style='color:green'>✓</span> |
30+
| `ti_AllocString` | <span style='color:red'>✗</span> |
31+
| `ti_AllocList` | <span style='color:red'>✗</span> |
32+
| `ti_AllocMatrix` | <span style='color:red'>✗</span> |
33+
| `ti_AllocCplxList` | <span style='color:red'>✗</span> |
34+
| `ti_AllocEqu` | <span style='color:red'>✗</span> |
35+
36+
### src/graphx/graphx.h
37+
| Function | Tested ? |
38+
| -------- | ----------- |
39+
| `gfx_AllocSprite` | <span style='color:red'>✗</span> |
40+
| `gfx_Begin` | <span style='color:green'>✓</span> |
41+
| `gfx_End` | <span style='color:green'>✓</span> |
42+
| `gfx_Tilemap` | <span style='color:green'>✓</span> |
43+
| `gfx_Tilemap_NoClip` | <span style='color:red'>✗</span> |
44+
| `gfx_TransparentTilemap` | <span style='color:red'>✗</span> |
45+
| `gfx_TransparentTilemap_NoClip` | <span style='color:red'>✗</span> |
46+
| `gfx_TilePtr` | <span style='color:red'>✗</span> |
47+
| `gfx_TilePtrMapped` | <span style='color:red'>✗</span> |
48+
| `gfx_SetColor` | <span style='color:green'>✓</span> |
49+
| `gfx_SetTransparentColor` | <span style='color:green'>✓</span> |
50+
| `gfx_SetDefaultPalette` | <span style='color:red'>✗</span> |
51+
| `gfx_SetPalette` | <span style='color:green'>✓</span> |
52+
| `gfx_FillScreen` | <span style='color:green'>✓</span> |
53+
| `gfx_ZeroScreen` | <span style='color:red'>✗</span> |
54+
| `gfx_SetPixel` | <span style='color:red'>✗</span> |
55+
| `gfx_GetPixel` | <span style='color:red'>✗</span> |
56+
| `gfx_Line` | <span style='color:green'>✓</span> |
57+
| `gfx_Line_NoClip` | <span style='color:red'>✗</span> |
58+
| `gfx_CohenSutherlandClip` | <span style='color:red'>✗</span> |
59+
| `gfx_HorizLine` | <span style='color:red'>✗</span> |
60+
| `gfx_HorizLine_NoClip` | <span style='color:red'>✗</span> |
61+
| `gfx_VertLine` | <span style='color:red'>✗</span> |
62+
| `gfx_VertLine_NoClip` | <span style='color:red'>✗</span> |
63+
| `gfx_Rectangle` | <span style='color:green'>✓</span> |
64+
| `gfx_Rectangle_NoClip` | <span style='color:red'>✗</span> |
65+
| `gfx_FillRectangle` | <span style='color:green'>✓</span> |
66+
| `gfx_FillRectangle_NoClip` | <span style='color:green'>✓</span> |
67+
| `gfx_Circle` | <span style='color:green'>✓</span> |
68+
| `gfx_FillCircle` | <span style='color:green'>✓</span> |
69+
| `gfx_FillCircle_NoClip` | <span style='color:green'>✓</span> |
70+
| `gfx_Polygon` | <span style='color:green'>✓</span> |
71+
| `gfx_Polygon_NoClip` | <span style='color:red'>✗</span> |
72+
| `gfx_FillTriangle` | <span style='color:green'>✓</span> |
73+
| `gfx_FillTriangle_NoClip` | <span style='color:red'>✗</span> |
74+
| `gfx_SetDraw` | <span style='color:green'>✓</span> |
75+
| `gfx_GetDraw` | <span style='color:red'>✗</span> |
76+
| `gfx_SwapDraw` | <span style='color:green'>✓</span> |
77+
| `gfx_Blit` | <span style='color:green'>✓</span> |
78+
| `gfx_BlitLines` | <span style='color:green'>✓</span> |
79+
| `gfx_BlitRectangle` | <span style='color:green'>✓</span> |
80+
| `gfx_SetTextScale` | <span style='color:green'>✓</span> |
81+
| `gfx_PrintChar` | <span style='color:red'>✗</span> |
82+
| `gfx_PrintInt` | <span style='color:red'>✗</span> |
83+
| `gfx_PrintUInt` | <span style='color:green'>✓</span> |
84+
| `gfx_PrintString` | <span style='color:green'>✓</span> |
85+
| `gfx_PrintStringXY` | <span style='color:green'>✓</span> |
86+
| `gfx_GetTextX` | <span style='color:red'>✗</span> |
87+
| `gfx_GetTextY` | <span style='color:red'>✗</span> |
88+
| `gfx_SetTextXY` | <span style='color:red'>✗</span> |
89+
| `gfx_SetTextConfig` | <span style='color:green'>✓</span> |
90+
| `gfx_SetTextFGColor` | <span style='color:green'>✓</span> |
91+
| `gfx_SetTextBGColor` | <span style='color:green'>✓</span> |
92+
| `gfx_SetTextTransparentColor` | <span style='color:green'>✓</span> |
93+
| `gfx_Sprite` | <span style='color:green'>✓</span> |
94+
| `gfx_Sprite_NoClip` | <span style='color:green'>✓</span> |
95+
| `gfx_TransparentSprite` | <span style='color:green'>✓</span> |
96+
| `gfx_TransparentSprite_NoClip` | <span style='color:green'>✓</span> |
97+
| `gfx_GetSprite` | <span style='color:green'>✓</span> |
98+
| `gfx_ScaledSprite_NoClip` | <span style='color:green'>✓</span> |
99+
| `gfx_ScaledTransparentSprite_NoClip` | <span style='color:green'>✓</span> |
100+
| `gfx_RotatedScaledTransparentSprite_NoClip` | <span style='color:red'>✗</span> |
101+
| `gfx_RotatedScaledSprite_NoClip` | <span style='color:green'>✓</span> |
102+
| `gfx_FlipSpriteX` | <span style='color:red'>✗</span> |
103+
| `gfx_FlipSpriteY` | <span style='color:green'>✓</span> |
104+
| `gfx_RotateSpriteC` | <span style='color:green'>✓</span> |
105+
| `gfx_RotateSpriteCC` | <span style='color:green'>✓</span> |
106+
| `gfx_RotateSpriteHalf` | <span style='color:green'>✓</span> |
107+
| `gfx_ScaleSprite` | <span style='color:red'>✗</span> |
108+
| `gfx_RotateScaleSprite` | <span style='color:red'>✗</span> |
109+
| `gfx_GetSpriteChar` | <span style='color:green'>✓</span> |
110+
| `gfx_SetFontData` | <span style='color:red'>✗</span> |
111+
| `gfx_SetFontSpacing` | <span style='color:red'>✗</span> |
112+
| `gfx_SetFontHeight` | <span style='color:red'>✗</span> |
113+
| `gfx_SetMonospaceFont` | <span style='color:green'>✓</span> |
114+
| `gfx_GetStringWidth` | <span style='color:green'>✓</span> |
115+
| `gfx_GetCharWidth` | <span style='color:green'>✓</span> |
116+
| `gfx_SetClipRegion` | <span style='color:green'>✓</span> |
117+
| `gfx_GetClipRegion` | <span style='color:red'>✗</span> |
118+
| `gfx_ShiftDown` | <span style='color:green'>✓</span> |
119+
| `gfx_ShiftUp` | <span style='color:red'>✗</span> |
120+
| `gfx_ShiftLeft` | <span style='color:red'>✗</span> |
121+
| `gfx_ShiftRight` | <span style='color:red'>✗</span> |
122+
| `gfx_Lighten` | <span style='color:green'>✓</span> |
123+
| `gfx_Darken` | <span style='color:green'>✓</span> |
124+
| `gfx_FloodFill` | <span style='color:green'>✓</span> |
125+
| `gfx_RLETSprite` | <span style='color:green'>✓</span> |
126+
| `gfx_RLETSprite_NoClip` | <span style='color:green'>✓</span> |
127+
| `gfx_ConvertFromRLETSprite` | <span style='color:green'>✓</span> |
128+
| `gfx_ConvertToRLETSprite` | <span style='color:green'>✓</span> |
129+
| `gfx_ConvertToNewRLETSprite` | <span style='color:red'>✗</span> |
130+
| `gfx_LZDecompress` | <span style='color:red'>✗</span> |
131+
132+
### src/keypadc/keypadc.h
133+
| Function | Tested ? |
134+
| -------- | ----------- |
135+
| `kb_Scan` | <span style='color:green'>✓</span> |
136+
| `kb_ScanGroup` | <span style='color:red'>✗</span> |
137+
| `kb_AnyKey` | <span style='color:red'>✗</span> |
138+
| `kb_Reset` | <span style='color:red'>✗</span> |
139+
140+
### src/ce/tice.h
141+
| Function | Tested ? |
142+
| -------- | ----------- |
143+
| `random` | <span style='color:green'>✓</span> |
144+
| `srandom` | <span style='color:red'>✗</span> |
145+
| `delay` | <span style='color:green'>✓</span> |
146+
| `boot_SetDate` | <span style='color:red'>✗</span> |
147+
| `boot_GetDate` | <span style='color:red'>✗</span> |
148+
| `boot_SetTime` | <span style='color:red'>✗</span> |
149+
| `boot_GetTime` | <span style='color:red'>✗</span> |
150+
| `boot_IsAfterNoon` | <span style='color:red'>✗</span> |
151+
| `boot_GetBootMajorVer` | <span style='color:red'>✗</span> |
152+
| `boot_GetBootMinorVer` | <span style='color:red'>✗</span> |
153+
| `boot_GetHardwareVer` | <span style='color:red'>✗</span> |
154+
| `boot_ClearVRAM` | <span style='color:red'>✗</span> |
155+
| `boot_CheckOnPressed` | <span style='color:red'>✗</span> |
156+
| `boot_DebugPrintf` | <span style='color:red'>✗</span> |
157+
| `boot_TurnOff` | <span style='color:red'>✗</span> |
158+
| `boot_NewLine` | <span style='color:red'>✗</span> |
159+
| `boot_GetBatteryStatus` | <span style='color:red'>✗</span> |
160+
| `boot_WaitShort` | <span style='color:green'>✓</span> |
161+
| `os_DisableCursor` | <span style='color:red'>✗</span> |
162+
| `os_EnableCursor` | <span style='color:red'>✗</span> |
163+
| `os_SetDrawFGColor` | <span style='color:red'>✗</span> |
164+
| `os_GetDrawFGColor` | <span style='color:red'>✗</span> |
165+
| `os_SetDrawBGColor` | <span style='color:red'>✗</span> |
166+
| `os_GetDrawBGColor` | <span style='color:red'>✗</span> |
167+
| `os_SetCursorPos` | <span style='color:green'>✓</span> |
168+
| `os_GetCursorPos` | <span style='color:red'>✗</span> |
169+
| `os_FontSelect` | <span style='color:red'>✗</span> |
170+
| `os_FontGetID` | <span style='color:red'>✗</span> |
171+
| `os_FontGetWidth` | <span style='color:red'>✗</span> |
172+
| `os_FontGetHeight` | <span style='color:red'>✗</span> |
173+
| `os_FontDrawText` | <span style='color:green'>✓</span> |
174+
| `os_FontDrawTransText` | <span style='color:red'>✗</span> |
175+
| `os_PutStrFull` | <span style='color:green'>✓</span> |
176+
| `os_PutStrLine` | <span style='color:red'>✗</span> |
177+
| `os_SetFlagByte` | <span style='color:red'>✗</span> |
178+
| `os_GetFlagByte` | <span style='color:red'>✗</span> |
179+
| `os_MemChk` | <span style='color:red'>✗</span> |
180+
| `os_ThrowError` | <span style='color:red'>✗</span> |
181+
| `os_GetSystemStats` | <span style='color:red'>✗</span> |
182+
| `os_PushErrorHandler` | <span style='color:red'>✗</span> |
183+
| `os_PopErrorHandler` | <span style='color:red'>✗</span> |
184+
| `os_GetSymTablePtr` | <span style='color:red'>✗</span> |
185+
| `os_CreateAppVar` | <span style='color:red'>✗</span> |
186+
| `os_NextSymEntry` | <span style='color:red'>✗</span> |
187+
| `os_ChkFindSym` | <span style='color:red'>✗</span> |
188+
| `os_RclAns` | <span style='color:red'>✗</span> |
189+
| `os_RealCopy` | <span style='color:red'>✗</span> |
190+
| `os_RealAcosRad` | <span style='color:red'>✗</span> |
191+
| `os_RealAsinRad` | <span style='color:red'>✗</span> |
192+
| `os_RealAtanRad` | <span style='color:red'>✗</span> |
193+
| `os_RealCosRad` | <span style='color:red'>✗</span> |
194+
| `os_RealRadToDeg` | <span style='color:red'>✗</span> |
195+
| `os_RealExp` | <span style='color:red'>✗</span> |
196+
| `os_RealFloor` | <span style='color:red'>✗</span> |
197+
| `os_RealFrac` | <span style='color:red'>✗</span> |
198+
| `os_RealRoundInt` | <span style='color:red'>✗</span> |
199+
| `os_RealLog` | <span style='color:red'>✗</span> |
200+
| `os_RealNeg` | <span style='color:red'>✗</span> |
201+
| `os_RealDegToRad` | <span style='color:red'>✗</span> |
202+
| `os_RealInv` | <span style='color:red'>✗</span> |
203+
| `os_RealSinRad` | <span style='color:red'>✗</span> |
204+
| `os_RealSqrt` | <span style='color:red'>✗</span> |
205+
| `os_RealTanRad` | <span style='color:red'>✗</span> |
206+
| `os_RealInt` | <span style='color:red'>✗</span> |
207+
| `os_CplxSquare` | <span style='color:red'>✗</span> |
208+
| `os_RealAdd` | <span style='color:red'>✗</span> |
209+
| `os_RealDiv` | <span style='color:red'>✗</span> |
210+
| `os_RealGcd` | <span style='color:red'>✗</span> |
211+
| `os_RealLcm` | <span style='color:red'>✗</span> |
212+
| `os_RealMax` | <span style='color:red'>✗</span> |
213+
| `os_RealMin` | <span style='color:red'>✗</span> |
214+
| `os_RealMul` | <span style='color:red'>✗</span> |
215+
| `os_RealNcr` | <span style='color:red'>✗</span> |
216+
| `os_RealNpr` | <span style='color:red'>✗</span> |
217+
| `os_RealPow` | <span style='color:red'>✗</span> |
218+
| `os_RealRandInt` | <span style='color:red'>✗</span> |
219+
| `os_RealMod` | <span style='color:red'>✗</span> |
220+
| `os_RealSub` | <span style='color:red'>✗</span> |
221+
| `os_RealRound` | <span style='color:red'>✗</span> |
222+
| `os_RealCompare` | <span style='color:red'>✗</span> |
223+
| `os_RealToInt24` | <span style='color:green'>✓</span> |
224+
| `os_Int24ToReal` | <span style='color:green'>✓</span> |
225+
| `os_RealToFloat` | <span style='color:red'>✗</span> |
226+
| `os_FloatToReal` | <span style='color:green'>✓</span> |
227+
| `os_RealToStr` | <span style='color:red'>✗</span> |
228+
| `os_StrToReal` | <span style='color:green'>✓</span> |
229+
| `os_TestFlagBits` | <span style='color:red'>✗</span> |
230+
| `os_SetFlagBits` | <span style='color:red'>✗</span> |
231+
| `os_ResetFlagBits` | <span style='color:red'>✗</span> |
232+
| `os_GetKey` | <span style='color:red'>✗</span> |
233+
| `os_GetCSC` | <span style='color:green'>✓</span> |
234+
| `boot_Set6MHzMode` | <span style='color:red'>✗</span> |
235+
| `boot_Set48MHzMode` | <span style='color:red'>✗</span> |
236+
| `boot_Set6MHzModeI` | <span style='color:red'>✗</span> |
237+
| `boot_Set48MHzModeI` | <span style='color:red'>✗</span> |
238+
| `os_ForceCmdNoChar` | <span style='color:red'>✗</span> |
239+
| `_OS` | <span style='color:red'>✗</span> |
240+
| `asm_MoveUp` | <span style='color:red'>✗</span> |
241+
| `asm_MoveDown` | <span style='color:red'>✗</span> |
242+
| `asm_HomeUp` | <span style='color:red'>✗</span> |
243+
| `asm_RunIndicOn` | <span style='color:red'>✗</span> |
244+
| `asm_RunIndicOff` | <span style='color:red'>✗</span> |
245+
| `asm_DisableAPD` | <span style='color:red'>✗</span> |
246+
| `asm_EnableAPD` | <span style='color:red'>✗</span> |
247+
| `asm_ArcChk` | <span style='color:red'>✗</span> |
248+
| `asm_ClrLCDFull` | <span style='color:red'>✗</span> |
249+
| `asm_ClrLCD` | <span style='color:red'>✗</span> |
250+
| `asm_DrawStatusBar` | <span style='color:red'>✗</span> |
251+
| `asm_DelRes` | <span style='color:red'>✗</span> |
252+
| `asm_ClrTxtShd` | <span style='color:red'>✗</span> |
253+
254+
### src/ce/decompress.h
255+
| Function | Tested ? |
256+
| -------- | ----------- |
257+
| `dzx7_Standard` | <span style='color:green'>✓</span> |
258+
| `dzx7_Turbo` | <span style='color:green'>✓</span> |
259+
260+
### src/ce/debug.h
261+
| Function | Tested ? |
262+
| -------- | ----------- |
263+
| `Debugger` | <span style='color:red'>✗</span> |
264+
| `SetBreakpoint` | <span style='color:red'>✗</span> |
265+
| `RemoveBreakpoint` | <span style='color:red'>✗</span> |
266+
| `SetWatchpoint` | <span style='color:green'>✓</span> |
267+
| `SetReadWatchpoint` | <span style='color:red'>✗</span> |
268+
| `SetWriteWatchpoint` | <span style='color:green'>✓</span> |
269+
| `SetReadWriteWatchpoint` | <span style='color:red'>✗</span> |
270+
| `RemoveWatchpoint` | <span style='color:green'>✓</span> |
271+
| `RemoveAllWatchpoints` | <span style='color:red'>✗</span> |
272+
| `RemoveAllBreakpoints` | <span style='color:red'>✗</span> |

0 commit comments

Comments
 (0)