From 015d289a658142e7484fdaea4da25c2c111356bd Mon Sep 17 00:00:00 2001 From: Renat Shakirov Date: Tue, 13 Jun 2023 20:04:51 +0300 Subject: [PATCH 1/7] Add code owners list --- CODEOWNERS | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 CODEOWNERS diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..1e0fd9b --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,2 @@ +# Default assignment +* @turbocat2001 @rgimad From d182696cced16815f81d91dcadb10887fdca26d9 Mon Sep 17 00:00:00 2001 From: Renat Shakirov Date: Tue, 13 Jun 2023 20:05:18 +0300 Subject: [PATCH 2/7] Update Git configs --- .gitattributes | 20 ++++++++++++++++++++ .gitignore | 2 ++ 2 files changed, 22 insertions(+) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..0f2c422 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,20 @@ +# Global attributes for forcing line endings normalization of specific files + +* text=auto + +# Sources +*.asm text eol=lf encoding=utf-8 +*.asc text eol=lf encoding=utf-8 +*.inc text eol=lf encoding=utf-8 + +# Scripts +*.lua text eol=crlf encoding=utf-8 +*.py text eol=crlf encoding=utf-8 + +# Configs +*.cfg text eol=crlf encoding=utf-8 +*.ini text eol=crlf encoding=utf-8 + +# Assets +*.cur binary +*.fnt binary diff --git a/.gitignore b/.gitignore index 119ce12..c913253 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +# Global ignoring of different binaries and another temporary files + *.mnt* *.raw *.iso From ac395d3cd7557012dc5476f9dcad5bb75eb39f02 Mon Sep 17 00:00:00 2001 From: Renat Shakirov Date: Tue, 13 Jun 2023 20:05:37 +0300 Subject: [PATCH 3/7] Add minimal readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9641224 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Kolibri OS + +__Kolibri__ is a very tiny and incredibly fast operating system + +## Overview + +The speed and compactness is achieved due to the fact that the kernel and most programs are written in the __FASM__ assembler, thereby optimized for __x86__ processors as much as possible. Only 8 megabytes of RAM is enough to run + +__Kolibri__ separated from __MenuetOS__ in 2004, and since then has been developed by an international community of programmers. Work is underway to make life easier for developers and users + +## License + +Contents of this repository licensed under terms of the __GNU GPL 2 license__ unless otherwise specified. See [this](./LICENSE) file for details From e3e6d061e426b0cf0861efa06b916fee93611dfb Mon Sep 17 00:00:00 2001 From: Egor Ananyin Date: Sun, 18 Jun 2023 13:40:53 +0300 Subject: [PATCH 4/7] Normalize line endings --- kernel/Tupfile.lua | 20 +- kernel/asmxygen.py | 2414 ++++---- kernel/bootloader/Tupfile.lua | 6 +- .../after_win/Tupfile.lua | 4 +- .../extended_primary_loader/cdfs/Tupfile.lua | 4 +- .../extended_primary_loader/fat1x/Tupfile.lua | 6 +- .../extended_primary_loader/fat32/Tupfile.lua | 6 +- kernel/bootloader/uefi4kos/Tupfile.lua | 6 +- kernel/core/Tupfile.lua | 6 +- kernel/docs/doxygen/doxygen.cfg | 5224 ++++++++--------- kernel/sec_loader/trunk/boot/floppy.asc | 96 +- kernel/sec_loader/trunk/startos.ini | 196 +- 12 files changed, 3994 insertions(+), 3994 deletions(-) diff --git a/kernel/Tupfile.lua b/kernel/Tupfile.lua index bc7da2a..c36cd04 100644 --- a/kernel/Tupfile.lua +++ b/kernel/Tupfile.lua @@ -1,10 +1,10 @@ -if tup.getconfig("NO_FASM") ~= "" then return end -tup.rule("echo lang fix " .. ((tup.getconfig("LANG") == "") and "en" or tup.getconfig("LANG")) .. " > %o", {"lang.inc"}) -tup.rule("git rev-parse HEAD > %o", {"rev.inc"}) -tup.rule({"bootbios.asm", extra_inputs = {"lang.inc"}}, "fasm %f %o ", "bootbios.bin") -tup.rule({"bootbios.asm", extra_inputs = {"lang.inc"}}, "fasm %f %o -dextended_primary_loader=1", "bootbios.bin.ext_loader") -tup.rule({"bootbios.asm", extra_inputs = {"lang.inc"}}, "fasm %f %o -dpretest_build=1", "bootbios.bin.pretest") -tup.rule({"kernel.asm", extra_inputs = {"bootbios.bin", "lang.inc", "rev.inc"}}, "fasm -m 65536 %f %o " .. tup.getconfig("KERPACK_CMD"), "kernel.mnt") -tup.rule({"kernel.asm", extra_inputs = {"bootbios.bin.ext_loader", "lang.inc", "rev.inc"}}, "fasm -m 131072 %f %o -s %o.fas -dextended_primary_loader=1" .. tup.getconfig("KERPACK_CMD"), {"kernel.mnt.ext_loader", extra_outputs = {"kernel.mnt.ext_loader.fas"}}) -tup.rule({"kernel.asm", extra_inputs = {"bootbios.bin.pretest", "lang.inc", "rev.inc"}}, "fasm -m 65536 %f %o -dpretest_build=1 -ddebug_com_base=0xe9", "kernel.mnt.pretest") -tup.rule({"kernel.asm", extra_inputs = {"lang.inc", "rev.inc"}}, "fasm -m 65536 %f %o -dUEFI=1 -dextended_primary_loader=1", "kolibri.krn") +if tup.getconfig("NO_FASM") ~= "" then return end +tup.rule("echo lang fix " .. ((tup.getconfig("LANG") == "") and "en" or tup.getconfig("LANG")) .. " > %o", {"lang.inc"}) +tup.rule("git rev-parse HEAD > %o", {"rev.inc"}) +tup.rule({"bootbios.asm", extra_inputs = {"lang.inc"}}, "fasm %f %o ", "bootbios.bin") +tup.rule({"bootbios.asm", extra_inputs = {"lang.inc"}}, "fasm %f %o -dextended_primary_loader=1", "bootbios.bin.ext_loader") +tup.rule({"bootbios.asm", extra_inputs = {"lang.inc"}}, "fasm %f %o -dpretest_build=1", "bootbios.bin.pretest") +tup.rule({"kernel.asm", extra_inputs = {"bootbios.bin", "lang.inc", "rev.inc"}}, "fasm -m 65536 %f %o " .. tup.getconfig("KERPACK_CMD"), "kernel.mnt") +tup.rule({"kernel.asm", extra_inputs = {"bootbios.bin.ext_loader", "lang.inc", "rev.inc"}}, "fasm -m 131072 %f %o -s %o.fas -dextended_primary_loader=1" .. tup.getconfig("KERPACK_CMD"), {"kernel.mnt.ext_loader", extra_outputs = {"kernel.mnt.ext_loader.fas"}}) +tup.rule({"kernel.asm", extra_inputs = {"bootbios.bin.pretest", "lang.inc", "rev.inc"}}, "fasm -m 65536 %f %o -dpretest_build=1 -ddebug_com_base=0xe9", "kernel.mnt.pretest") +tup.rule({"kernel.asm", extra_inputs = {"lang.inc", "rev.inc"}}, "fasm -m 65536 %f %o -dUEFI=1 -dextended_primary_loader=1", "kolibri.krn") diff --git a/kernel/asmxygen.py b/kernel/asmxygen.py index f3b6b53..6575de3 100644 --- a/kernel/asmxygen.py +++ b/kernel/asmxygen.py @@ -1,1207 +1,1207 @@ -import re -import os -import argparse -import sys -import pickle -import hashlib -import difflib - -# fasm keywords -keywords = [ - "align", "equ", "org", "while", "load", "store", "times", "repeat", - "display", "err", "assert", "if", "aaa", "aad", "aam", "aas", "adc", - "add", "addpd", "addps", "addsd", "addss", "addsubpd", "addsubps", "adox", - "aesdeclast", "aesenc", "aesenclast", "aesimc", "aeskeygenassist", "and", - "andnpd", "andnps", "andpd", "andps", "arpl", "bextr", "blendpd", - "blendvpd", "blendvps", "blsi", "blsmsk", "blsr", "bndcl", "bndcn", - "bndldx", "bndmk", "bndmov", "bndstx", "bound", "bsf", "bsr", "bswap", - "btc", "btr", "bts", "bzhi", "call", "cbw", "cdq", "cdqe", "clac", "clc", - "cldemote", "clflush", "clflushopt", "cli", "clts", "clwb", "cmc", "cmova", - "cmovb", "cmovbe", "cmovc", "cmove", "cmovg", "cmovge", "cmovl", "cmovle", - "cmovnae", "cmovnb", "cmovnbe", "cmovnc", "cmovne", "cmovng", "cmovnge", - "cmovnle", "cmovno", "cmovnp", "cmovns", "cmovnz", "cmovo", "cmovp", - "cmovpo", "cmovs", "cmovz", "cmp", "cmppd", "cmpps", "cmps", "cmpsb", - "cmpsd", "cmpsq", "cmpss", "cmpsw", "cmpxchg", "cmpxchg16b", "cmpxchg8b", - "comiss", "cpuid", "cqo", "crc32", "cvtdq2pd", "cvtdq2ps", "cvtpd2dq", - "cvtpd2ps", "cvtpi2pd", "cvtpi2ps", "cvtps2dq", "cvtps2pd", "cvtps2pi", - "cvtsd2ss", "cvtsi2sd", "cvtsi2ss", "cvtss2sd", "cvtss2si", "cvttpd2dq", - "cvttps2dq", "cvttps2pi", "cvttsd2si", "cvttss2si", "cwd", "cwde", "daa", - "dec", "div", "divpd", "divps", "divsd", "divss", "dppd", "dpps", "emms", - "extractps", "f2xm1", "fabs", "fadd", "faddp", "fbld", "fbstp", "fchs", - "fcmova", "fcmovae", "fcmovb", "fcmovbe", "fcmovc", "fcmove", "fcmovg", - "fcmovl", "fcmovle", "fcmovna", "fcmovnae", "fcmovnb", "fcmovnbe", - "fcmovne", "fcmovng", "fcmovnge", "fcmovnl", "fcmovnle", "fcmovno", - "fcmovns", "fcmovnz", "fcmovo", "fcmovp", "fcmovpe", "fcmovpo", "fcmovs", - "fcom", "fcomi", "fcomip", "fcomp", "fcompp", "fcos", "fdecstp", "fdiv", - "fdivr", "fdivrp", "ffree", "fiadd", "ficom", "ficomp", "fidiv", "fidivr", - "fimul", "fincstp", "finit", "fist", "fistp", "fisttp", "fisub", "fisubr", - "fld1", "fldcw", "fldenv", "fldl2e", "fldl2t", "fldlg2", "fldln2", "fldpi", - "fmul", "fmulp", "fnclex", "fninit", "fnop", "fnsave", "fnstcw", "fnstenv", - "fpatan", "fprem", "fprem1", "fptan", "frndint", "frstor", "fsave", - "fsin", "fsincos", "fsqrt", "fst", "fstcw", "fstenv", "fstp", "fstsw", - "fsubp", "fsubr", "fsubrp", "ftst", "fucom", "fucomi", "fucomip", "fucomp", - "fwait", "fxam", "fxch", "fxrstor", "fxsave", "fxtract", "fyl2x", - "gf2p8affineinvqb", "gf2p8affineqb", "gf2p8mulb", "haddpd", "haddps", - "hsubpd", "hsubps", "idiv", "imul", "in", "inc", "ins", "insb", "insd", - "insw", "int", "int1", "int3", "into", "invd", "invlpg", "invpcid", "iret", - "jmp", "ja", "jae", "jb", "jbe", "jc", "jcxz", "jecxz", "je", "jg", "jge", - "jle", "jna", "jnae", "jnb", "jnbe", "jnc", "jne", "jng", "jnge", "jnl", - "jno", "jnp", "jns", "jnz", "jo", "jp", "jpe", "jpo", "js", "jz", "kaddb", - "kaddq", "kaddw", "kandb", "kandd", "kandnb", "kandnd", "kandnq", "kandnw", - "kandw", "kmovb", "kmovd", "kmovq", "kmovw", "knotb", "knotd", "knotq", - "korb", "kord", "korq", "kortestb", "kortestd", "kortestq", "kortestw", - "kshiftlb", "kshiftld", "kshiftlq", "kshiftlw", "kshiftrb", "kshiftrd", - "kshiftrw", "ktestb", "ktestd", "ktestq", "ktestw", "kunpckbw", "kunpckdq", - "kxnorb", "kxnord", "kxnorq", "kxnorw", "kxorb", "kxord", "kxorq", "kxorw", - "lar", "lddqu", "ldmxcsr", "lds", "lea", "leave", "les", "lfence", "lfs", - "lgs", "lidt", "lldt", "lmsw", "lock", "lods", "lodsb", "lodsd", "lodsq", - "loop", "loopa", "loopae", "loopb", "loopbe", "loopc", "loope", "loopg", - "loopl", "loople", "loopna", "loopnae", "loopnb", "loopnbe", "loopnc", - "loopng", "loopnge", "loopnl", "loopnle", "loopno", "loopnp", "loopns", - "loopo", "loopp", "looppe", "looppo", "loops", "loopz", "lsl", "lss", - "lzcnt", "maskmovdqu", "maskmovq", "maxpd", "maxps", "maxsd", "maxss", - "minpd", "minps", "minsd", "minss", "monitor", "mov", "movapd", "movaps", - "movd", "movddup", "movdir64b", "movdiri", "movdq2q", "movdqa", "movdqu", - "movhpd", "movhps", "movlhps", "movlpd", "movlps", "movmskpd", "movmskps", - "movntdqa", "movnti", "movntpd", "movntps", "movntq", "movq", "movq", - "movs", "movsb", "movsd", "movsd", "movshdup", "movsldup", "movsq", - "movsw", "movsx", "movsxd", "movupd", "movups", "movzx", "mpsadbw", "mul", - "mulps", "mulsd", "mulss", "mulx", "mwait", "neg", "nop", "not", "or", - "orps", "out", "outs", "outsb", "outsd", "outsw", "pabsb", "pabsd", - "pabsw", "packssdw", "packsswb", "packusdw", "packuswb", "paddb", "paddd", - "paddsb", "paddsw", "paddusb", "paddusw", "paddw", "palignr", "pand", - "pause", "pavgb", "pavgw", "pblendvb", "pblendw", "pclmulqdq", "pcmpeqb", - "pcmpeqq", "pcmpeqw", "pcmpestri", "pcmpestrm", "pcmpgtb", "pcmpgtd", - "pcmpgtw", "pcmpistri", "pcmpistrm", "pdep", "pext", "pextrb", "pextrd", - "pextrw", "phaddd", "phaddsw", "phaddw", "phminposuw", "phsubd", "phsubsw", - "pinsrb", "pinsrd", "pinsrq", "pinsrw", "pmaddubsw", "pmaddwd", "pmaxsb", - "pmaxsq", "pmaxsw", "pmaxub", "pmaxud", "pmaxuq", "pmaxuw", "pminsb", - "pminsq", "pminsw", "pminub", "pminud", "pminuq", "pminuw", "pmovmskb", - "pmovzx", "pmuldq", "pmulhrsw", "pmulhuw", "pmulhw", "pmulld", "pmullq", - "pmuludq", "pop", "popa", "popad", "popcnt", "popf", "popfd", "popfq", - "prefetchw", "prefetchh", "psadbw", "pshufb", "pshufd", "pshufhw", - "pshufw", "psignb", "psignd", "psignw", "pslld", "pslldq", "psllq", - "psrad", "psraq", "psraw", "psrld", "psrldq", "psrlq", "psrlw", "psubb", - "psubq", "psubsb", "psubsw", "psubusb", "psubusw", "psubw", "ptest", - "punpckhbw", "punpckhdq", "punpckhqdq", "punpckhwd", "punpcklbw", - "punpcklqdq", "punpcklwd", "push", "pushw", "pushd", "pusha", "pushad", - "pushfd", "pushfq", "pxor", "rcl", "rcpps", "rcpss", "rcr", "rdfsbase", - "rdmsr", "rdpid", "rdpkru", "rdpmc", "rdrand", "rdseed", "rdtsc", "rdtscp", - "repe", "repne", "repnz", "repz", "ret", "rol", "ror", "rorx", "roundpd", - "roundsd", "roundss", "rsm", "rsqrtps", "rsqrtss", "sahf", "sal", "sar", - "sbb", "scas", "scasb", "scasd", "scasw", "seta", "setae", "setb", "setbe", - "sete", "setg", "setge", "setl", "setle", "setna", "setnae", "setnb", - "setnc", "setne", "setng", "setnge", "setnl", "setnle", "setno", "setnp", - "setnz", "seto", "setp", "setpe", "setpo", "sets", "setz", "sfence", - "sha1msg1", "sha1msg2", "sha1nexte", "sha1rnds4", "sha256msg1", - "sha256rnds2", "shl", "shld", "shlx", "shr", "shrd", "shrx", "shufpd", - "sidt", "sldt", "smsw", "sqrtpd", "sqrtps", "sqrtsd", "sqrtss", "stac", - "std", "sti", "stmxcsr", "stos", "stosb", "stosd", "stosq", "stosw", "str", - "subpd", "subps", "subsd", "subss", "swapgs", "syscall", "sysenter", - "sysret", "test", "tpause", "tzcnt", "ucomisd", "ucomiss", "ud", - "umwait", "unpckhpd", "unpckhps", "unpcklpd", "unpcklps", "valignd", - "vblendmpd", "vblendmps", "vbroadcast", "vcompresspd", "vcompressps", - "vcvtpd2udq", "vcvtpd2uqq", "vcvtph2ps", "vcvtps2ph", "vcvtps2qq", - "vcvtps2uqq", "vcvtqq2pd", "vcvtqq2ps", "vcvtsd2usi", "vcvtss2usi", - "vcvttpd2udq", "vcvttpd2uqq", "vcvttps2qq", "vcvttps2udq", "vcvttps2uqq", - "vcvttss2usi", "vcvtudq2pd", "vcvtudq2ps", "vcvtuqq2pd", "vcvtuqq2ps", - "vcvtusi2ss", "vdbpsadbw", "verr", "verw", "vexpandpd", "vexpandps", - "vextractf32x4", "vextractf32x8", "vextractf64x2", "vextractf64x4", - "vextracti32x4", "vextracti32x8", "vextracti64x2", "vextracti64x4", - "vfixupimmps", "vfixupimmsd", "vfixupimmss", "vfmadd132pd", "vfmadd132ps", - "vfmadd132ss", "vfmadd213pd", "vfmadd213ps", "vfmadd213sd", "vfmadd213ss", - "vfmadd231ps", "vfmadd231sd", "vfmadd231ss", "vfmaddsub132pd", - "vfmaddsub213pd", "vfmaddsub213ps", "vfmaddsub231pd", "vfmaddsub231ps", - "vfmsub132ps", "vfmsub132sd", "vfmsub132ss", "vfmsub213pd", "vfmsub213ps", - "vfmsub213ss", "vfmsub231pd", "vfmsub231ps", "vfmsub231sd", "vfmsub231ss", - "vfmsubadd132ps", "vfmsubadd213pd", "vfmsubadd213ps", "vfmsubadd231pd", - "vfnmadd132pd", "vfnmadd132ps", "vfnmadd132sd", "vfnmadd132ss", - "vfnmadd213ps", "vfnmadd213sd", "vfnmadd213ss", "vfnmadd231pd", - "vfnmadd231sd", "vfnmadd231ss", "vfnmsub132pd", "vfnmsub132ps", - "vfnmsub132ss", "vfnmsub213pd", "vfnmsub213ps", "vfnmsub213sd", - "vfnmsub231pd", "vfnmsub231ps", "vfnmsub231sd", "vfnmsub231ss", - "vfpclassps", "vfpclasssd", "vfpclassss", "vgatherdpd", "vgatherdpd", - "vgatherdps", "vgatherqpd", "vgatherqpd", "vgatherqps", "vgatherqps", - "vgetexpps", "vgetexpsd", "vgetexpss", "vgetmantpd", "vgetmantps", - "vgetmantss", "vinsertf128", "vinsertf32x4", "vinsertf32x8", - "vinsertf64x4", "vinserti128", "vinserti32x4", "vinserti32x8", - "vinserti64x4", "vmaskmov", "vmovdqa32", "vmovdqa64", "vmovdqu16", - "vmovdqu64", "vmovdqu8", "vpblendd", "vpblendmb", "vpblendmd", "vpblendmq", - "vpbroadcast", "vpbroadcastb", "vpbroadcastd", "vpbroadcastm", - "vpbroadcastw", "vpcmpb", "vpcmpd", "vpcmpq", "vpcmpub", "vpcmpud", - "vpcmpuw", "vpcmpw", "vpcompressd", "vpcompressq", "vpconflictd", - "vperm2f128", "vperm2i128", "vpermb", "vpermd", "vpermi2b", "vpermi2d", - "vpermi2ps", "vpermi2q", "vpermi2w", "vpermilpd", "vpermilps", "vpermpd", - "vpermq", "vpermt2b", "vpermt2d", "vpermt2pd", "vpermt2ps", "vpermt2q", - "vpermw", "vpexpandd", "vpexpandq", "vpgatherdd", "vpgatherdd", - "vpgatherdq", "vpgatherqd", "vpgatherqd", "vpgatherqq", "vpgatherqq", - "vplzcntq", "vpmadd52huq", "vpmadd52luq", "vpmaskmov", "vpmovb2m", - "vpmovdb", "vpmovdw", "vpmovm2b", "vpmovm2d", "vpmovm2q", "vpmovm2w", - "vpmovqb", "vpmovqd", "vpmovqw", "vpmovsdb", "vpmovsdw", "vpmovsqb", - "vpmovsqw", "vpmovswb", "vpmovusdb", "vpmovusdw", "vpmovusqb", "vpmovusqd", - "vpmovuswb", "vpmovw2m", "vpmovwb", "vpmultishiftqb", "vprold", "vprolq", - "vprolvq", "vprord", "vprorq", "vprorvd", "vprorvq", "vpscatterdd", - "vpscatterqd", "vpscatterqq", "vpsllvd", "vpsllvq", "vpsllvw", "vpsravd", - "vpsravw", "vpsrlvd", "vpsrlvq", "vpsrlvw", "vpternlogd", "vpternlogq", - "vptestmd", "vptestmq", "vptestmw", "vptestnmb", "vptestnmd", "vptestnmq", - "vrangepd", "vrangeps", "vrangesd", "vrangess", "vrcp14pd", "vrcp14ps", - "vrcp14ss", "vreducepd", "vreduceps", "vreducesd", "vreducess", - "vrndscaleps", "vrndscalesd", "vrndscaless", "vrsqrt14pd", "vrsqrt14ps", - "vrsqrt14ss", "vscalefpd", "vscalefps", "vscalefsd", "vscalefss", - "vscatterdps", "vscatterqpd", "vscatterqps", "vshuff32x4", "vshuff64x2", - "vshufi64x2", "vtestpd", "vtestps", "vzeroall", "vzeroupper", "wait", - "wrfsbase", "wrgsbase", "wrmsr", "wrpkru", "xabort", "xacquire", "xadd", - "xchg", "xend", "xgetbv", "xlat", "xlatb", "xor", "xorpd", "xorps", - "xrstor", "xrstors", "xsave", "xsavec", "xsaveopt", "xsaves", "xsetbv", -] - -fasm_types = [ - "db", "rb", - "dw", "rw", - "dd", "rd", - "dp", "rp", - "df", "rf", - "dq", "rq", - "dt", "rt", - "du", -] - - -# Add kind flag to identifier in id2kind -def id_add_kind(identifier, kind): - if identifier not in id2kind: - id2kind[identifier] = '' - id2kind[identifier] += kind - - -# Remove kind flag of identifier in id2kind -def id_remove_kind(identifier, kind): - if identifier in id2kind: - if kind in id2kind[identifier]: - id2kind[identifier] = id2kind[identifier].replace(kind, '') - - -# Get kind of an identifier -def id_get_kind(identifier): - if identifier in id2kind: - return id2kind[identifier] - else: - return '' - - -class LegacyAsmReader: - def __init__(self, file): - self.file = file - self.lines = open(file, "r", encoding="utf-8").readlines() - self.line_idx = 0 - self.i = 0 - - def currline(self): - return self.lines[self.line_idx] - - def curr(self): - try: - return self.lines[self.line_idx][self.i] - except: - return '' - - def step(self): - c = self.curr() - self.i += 1 - # Wrap the line if '\\' followed by whitespaces and/or comment - while self.curr() == '\\': - i_of_backslash = self.i - self.i += 1 - while self.curr().isspace(): - self.i += 1 - if self.curr() == ';' or self.curr() == '': - self.line_idx += 1 - self.i = 0 - else: - # There's something other than a comment after the backslash - # So don't interpret the backslash as a line wrap - self.i = i_of_backslash - break - return c - - def nextline(self): - c = self.curr() - while c != '': - c = self.step() - self.line_idx += 1 - self.i = 0 - - def no_lines(self): - if self.line_idx >= len(self.lines): - return True - return False - - def location(self): - return f"{self.file}:{self.line_idx + 1}" - - def skip_spaces(self): - while self.curr().isspace(): - self.step() - - -class AsmReaderRecognizingStrings(LegacyAsmReader): - def __init__(self, file): - super().__init__(file) - self.in_string = None - self.should_recognize_strings = True - - def step(self): - c = super().step() - if self.should_recognize_strings and (c == '"' or c == "'"): - # If just now we was at the double or single quotation mark - # and we aren't in a string yet then say - # "we are in a string openned with this quotation mark now" - if self.in_string is None: - self.in_string = c - # If just now we was at the double or single quotation mark - # and we are in the string entered with the same quotation mark - # then say "we aren't in a string anymore" - elif self.in_string == c: - self.in_string = None - return c - - -class AsmReaderReadingComments(AsmReaderRecognizingStrings): - def __init__(self, file): - super().__init__(file) - self.status = dict() - self.status_reset() - self.comment = '' - - def status_reset(self): - # If the line has non-comment code - self.status_has_code = False - # If the line has a comment at the end - self.status_has_comment = False - # Let it recognize strings further, we are definitely out of a comment - self.should_recognize_strings = True - - def status_set_has_comment(self): - self.status_has_comment = True - # Don't let it recognize strings cause we are in a comment now - self.should_recognize_strings = False - - def status_set_has_code(self): - self.status_has_code = True - - def update_status(self): - # If we aren't in a comment and we aren't in a string - - # say we are now in a comment if ';' met - if (not self.status_has_comment and - not self.in_string and - self.curr() == ';'): - self.status_set_has_comment() - # Else if we are in a comment - collect the comment - elif self.status_has_comment: - self.comment += self.curr() - # Else if there's some non-whitespace character out of a comment - # then the line has code - elif not self.status_has_comment and not self.curr().isspace(): - self.status_set_has_code() - - def step(self): - # Get to the next character - c = super().step() - # Update status of the line according to the next character - self.update_status() - return c - - def nextline(self): - prev_line = self.currline() - super().nextline() - # If the line we leave was not a comment-only line - # then forget the collected comment - # Otherwise the collected comment should be complemented by - # comment from next line in step() - if self.status_has_code: - # But we should preserve comment for the next line - # If previous line set align (cause many functions re documented - # right before align set, not before their labels) - if not prev_line.startswith("align "): - self.comment = '' - # Reset the line status (now it's the status of the new line) - self.status_reset() - # Set new status for this line according to the - # first character in the line - self.update_status() - - -class AsmReaderFetchingIdentifiers(AsmReaderReadingComments): - def __init__(self, file): - super().__init__(file) - - def fetch_identifier(self): - self.skip_spaces() - result = '' - while is_id(self.curr()): - result += self.step() - return result - - -class AsmReader(AsmReaderFetchingIdentifiers): - def __init__(self, file): - super().__init__(file) - - -def append_file(full_path, contents): - if debug_mode: - if full_path not in output_files: - output_files[full_path] = "" - output_files[full_path] += contents - else: - f = open(full_path, "a") - f.write(contents) - f.close() - - -class AsmElement: - def __init__(self, location, name, comment): - global warnings - - # If the element was constructed during this execution then - # the element is new - self.new = True - self.location = location - self.file = self.location.split(':')[0].replace('\\', '/') - self.line = self.location.split(':')[1] - self.name = name - self.comment = comment - - if self.comment == '': - warnings += f'{self.location}: Undocumented element\n' - - def dump(self): - print(f"\n{self.location}: {self.name}") - print(f"{self.comment}") - - def emit(self, dest, doxycomment='', declaration=''): - # Do not emit anything if the symbol is marked as hidden in its comment - if '@dont_give_a_doxygen' in self.comment: - return - - global warnings - # Redefine default declaration - if declaration == '': - declaration = f'#define {self.name}' - # Check doxycomment - if not doxycomment.endswith('\n'): - doxycomment += '\n' - if doxycomment.split('@brief ')[1][0].islower(): - warnings += (f"{self.location}: Brief comment starting from " + - "lowercase\n") - # Build contents to emit - contents = '' - contents += '/**\n' - contents += doxycomment - contents += (f"@par Source\n" + - f"{self.file}:{self.line}\n") - contents += '*/\n' - contents += declaration - contents += '\n\n' - # Get path to file to emit this - full_path = dest + '/' + self.file - # Remove the file on first access if it was - # created by previous generation - if full_path not in created_files: - if os.path.isfile(full_path): - os.remove(full_path) - created_files.append(full_path) - # Create directories need for the file - os.makedirs(os.path.dirname(full_path), exist_ok=True) - contents = ''.join([i if ord(i) < 128 else '?' for i in contents]) - - append_file(full_path, contents) - - -class AsmVariable(AsmElement): - def __init__(self, location, name, comment, type, init): - super().__init__(location, name, comment) - self.type = type - self.init = init - - def dump(self): - super().dump() - print(f"(Variable)\n---") - - def emit(self, dest): - # Build doxycomment specific for the variable - doxycomment = '' - doxycomment += self.comment - if '@brief' not in doxycomment: - doxycomment = '@brief ' + doxycomment - doxycomment += (f"@par Initial value\n" + - f"{self.init}\n") - # Build the declaration - name = self.name.replace(".", "_") - var_type = self.type.replace(".", "_") - declaration = f"{var_type} {name};" - # Emit this - super().emit(dest, doxycomment, declaration) - - -class AsmFunction(AsmElement): - def __init__(self, location, name, comment, calling_convention, - args, used_regs): - super().__init__(location, name, comment) - self.calling_convention = calling_convention - self.args = args - self.used_regs = used_regs - - def dump(self): - super().dump() - print(f"(Function)\n---") - - def emit(self, dest): - # Build doxycomment specific for the variable - doxycomment = '' - doxycomment += self.comment - if '@brief' not in doxycomment: - doxycomment = '@brief ' + doxycomment - # If there was no arguments, maybe that's just a label - # then parse parameters from its comment - if len(self.args) == 0 and '@param' in self.comment: - i = 0 - while '@param' in self.comment[i:]: - i = self.comment.index('@param', i) - # Skip '@param' - i += len('@param') - # Skip spaces after '@param' - while self.comment[i].isspace(): - i += 1 - # Get the parameter name - name = '' - while is_id(self.comment[i]): - name += self.comment[i] - i += 1 - # Save the parameter - self.args.append((name, 'arg_t')) - # Build the arg list for declaration - arg_list = '(' - if len(self.args) > 0: - argc = 0 - for arg in self.args: - if argc != 0: - arg_list += ", " - arg_list += f"{arg[1]} {arg[0]}" - argc += 1 - arg_list += ')' - # Build the declaration - name = self.name.replace(".", "_") - declaration = f"void {name}{arg_list};" - # Emit this - super().emit(dest, doxycomment, declaration) - - -class AsmLabel(AsmElement): - def __init__(self, location, name, comment): - super().__init__(location, name, comment) - - def dump(self): - super().dump() - print(f"(Label)\n---") - - def emit(self, dest): - # Build doxycomment specific for the variable - doxycomment = '' - doxycomment += self.comment - if '@brief' not in doxycomment: - doxycomment = '@brief ' + doxycomment - # Build the declaration - name = self.name.replace(".", "_") - declaration = f"label {name};" - # Emit this - super().emit(dest, doxycomment, declaration) - - -class AsmMacro(AsmElement): - def __init__(self, location, name, comment, args): - super().__init__(location, name, comment) - self.args = args - - def dump(self): - super().dump() - print(f"(Macro)\n---") - - def emit(self, dest): - # Construct arg list without '['s, ']'s and '*'s - args = [arg for arg in self.args if arg not in "[]*"] - # Construct C-like arg list - arg_list = "" - if len(args) > 0: - arg_list += '(' - argc = 0 - for arg in args: - if argc != 0: - arg_list += ", " - arg_list += arg - argc += 1 - arg_list += ')' - # Build doxycomment - doxycomment = '' - doxycomment += self.comment - if '@brief' not in doxycomment: - doxycomment = '@brief ' + doxycomment - # Build declaration - declaration = f"#define {self.name}{arg_list}" - # Emit this - super().emit(dest, doxycomment, declaration) - - -class AsmStruct(AsmElement): - def __init__(self, location, name, comment, members): - super().__init__(location, name, comment) - self.members = members - - def dump(self): - super().dump() - print(f"(Struct)\n---") - - def emit(self, dest): - # Build doxycomment - doxycomment = '' - doxycomment += self.comment - if '@brief' not in doxycomment: - doxycomment = '@brief ' + doxycomment - doxycomment += '\n' - # Build declaration - declaration = f"struct {self.name}" + " {\n" - for member in self.members: - if type(member) == AsmVariable: - declaration += (f'\t{member.type} {member.name}; ' + - f'/**< {member.comment} */\n') - declaration += '};' - # Emit this - super().emit(dest, doxycomment, declaration) - - -class AsmUnion(AsmElement): - def __init__(self, location, name, comment, members): - super().__init__(location, name, comment) - self.members = members - - def dump(self): - super().dump() - print(f"(Union)\n---") - - def emit(self, dest): - # Build doxycomment - doxycomment = '' - doxycomment += self.comment - if '@brief' not in doxycomment: - doxycomment = '@brief ' + doxycomment - # Build declaration - declaration = f"union {self.name}" + " {};" - # Emit this - super().emit(dest, doxycomment, declaration) - - -class VariableNameIsMacroName: - def __init__(self, name): - self.name = name - - -def is_id(c): - return c.isprintable() and c not in "+-/*=<>()[]{};:,|&~#`'\" \n\r\t\v" - - -def is_starts_as_id(s): - return not s[0].isdigit() - - -def parse_after_macro(r): - location = r.location() - - # Skip spaces after the "macro" keyword - r.skip_spaces() - # Read macro name - name = "" - while is_id(r.curr()) or r.curr() == '#': - name += r.step() - # Skip spaces after macro name - r.skip_spaces() - # Find all arguments - args = [] - arg = '' - while r.curr() and r.curr() != ';' and r.curr() != '{': - # Collect identifier - if is_id(r.curr()): - arg += r.step() - # Save the collected identifier - elif r.curr() == ',': - args.append(arg) - arg = '' - r.step() - # Just push the '[' - elif r.curr() == '[': - args.append(r.step()) - # Just push the identifier and get ']' ready to be pushed on next comma - elif r.curr() == ']': - args.append(arg) - arg = r.step() - # Just push the identifier and get '*' ready to be pushed on next comma - elif r.curr() == '*': - args.append(arg) - arg = r.step() - # Just skip whitespaces - elif r.curr().isspace(): - r.step() - # Something unexpected - else: - raise Exception(f"Unexpected symbol '{r.curr()}' " + - f"at index #{r.i} in the macro declaration " + - f"at {location} " + - f"(line: {r.lines[r.line_idx]})\n''") - # Append the last argument - if arg != '': - args.append(arg) - # Skip t spaces after the argument list - r.skip_spaces() - # Get a comment if it is: read till the end of the line and - # get the comment from the reader - while r.curr() != '': - r.step() - comment = r.comment - # Find end of the macro - prev = '' - while True: - if r.curr() == '}' and prev != '\\': - break - elif r.curr() == '': - prev = '' - r.nextline() - continue - prev = r.step() - # Build the output - return AsmMacro(location, name, comment, args) - - -def parse_variable(r, first_word=None): - global warnings - location = r.location() - - # Skip spaces before variable name - r.skip_spaces() - # Get variable name - name = "" - # Read it if it was not supplied - if first_word is None: - while is_id(r.curr()): - name += r.step() - # Or use the supplied one instead - else: - name = first_word - # Check the name - # If it's 0 len, that means threr's something else than an - # identifier at the beginning - if len(name) == 0: - return None - # If it starts from digit or othervice illegally it's illegal - if not is_starts_as_id(name): - return None - # Get kind of the identifier from id2kind table - kind = id_get_kind(name) - # If it's a keyword, that's not a variable declaration - if ID_KIND_KEYWORD in kind: - return None - # If it's a macro name, that's not a variable declaration - if ID_KIND_MACRO_NAME in kind: - return VariableNameIsMacroName(name) - # If it's a datatype or a structure name that's not a - # variable declaration: that's just a data - # don't document just a data for now - if ID_KIND_STRUCT_NAME in kind or ID_KIND_FASM_TYPE in kind: - return None - # Skip spaces before type name - r.skip_spaces() - # Read type name - var_type = "" - while is_id(r.curr()): - var_type += r.step() - # Check the type name - if len(var_type) == 0: - # If there's no type identifier after the name - # maybe the name is something meaningful for the next parser - # return it - return name - # If it starts from digit or othervice illegally it's illegal - if not is_starts_as_id(var_type): - return None - # Get kind of type identifier - type_kind = id_get_kind(var_type) - # If it's a keyword, that's not a variable declaration - # return the two words of the lexical structure - if ID_KIND_KEYWORD in type_kind: - return (name, var_type) - # Skip spaces before the value - r.skip_spaces() - # Read the value until the comment or end of the line - value = "" - while r.curr() != ';' and r.curr() != '' and r.curr() != '\n': - value += r.step() - # Skip spaces after the value - r.skip_spaces() - # Read till end of the line to get a comment from the reader - while r.curr() != '': - r.step() - # Build the result - return AsmVariable(location, name, r.comment, var_type, value) - - -def parse_after_struct(r, as_union=True): - global warnings - location = r.location() - - # Skip spaces after "struct" keyword - r.skip_spaces() - # Read struct name - name = "" - while is_id(r.curr()): - name += r.step() - # Read till end of the line and get the comment from the reader - while r.curr() != '': - r.step() - comment = r.comment - # Get to the next line to parse struct members - r.nextline() - # Parse struct members - members = [] - while True: - r.skip_spaces() - var = parse_variable(r) - if type(var) == AsmVariable: - members.append(var) - elif type(var) == str: - if var == 'union': - # Parse the union as a struct - union = parse_after_struct(r, as_union=True) - members.append(union) - # Skip the ends of the union - r.nextline() - elif r.curr() == ':': - warnings += f"{r.location()}: Skept the label in the struct\n" - else: - raise Exception(f"Garbage in struct member at {location} " + - f" (got '{var}' identifier)") - elif type(var) == VariableNameIsMacroName: - if var.name == 'ends': - break - r.nextline() - # Return the result - if as_union: - return AsmStruct(location, name, comment, members) - else: - return AsmUnion(location, name, comment, members) - - -def parse_after_proc(r): - # Get proc name - name = r.fetch_identifier() - # Next identifier after the proc name - identifier = r.fetch_identifier() - # Check if the id is 'stdcall' or 'c' (calling convention specifier) - # and if so - save the convention and lookup the next identifier - calling_convention = '' - if identifier == 'stdcall' or identifier == 'c': - calling_convention = identifier - # If next is a comma, just skip it - if r.curr() == ',': - r.step() - # Read the next identifier - identifier = r.fetch_identifier() - # Check if the id is 'uses' (used register list specifier) - # and if so save the used register list - used_regs = [] - if identifier == 'uses': - # Read the registers - while True: - reg_name = r.fetch_identifier() - if reg_name != '': - used_regs.append(reg_name) - else: - break - # If next is a comma, just skip it - if r.curr() == ',': - r.step() - # Read the next identifier - identifier = r.fetch_identifier() - # Check if there are argument identifiers - args = [] - while identifier != '': - arg_name = identifier - arg_type = 'arg_t' - # Skip spaces after argument name - r.skip_spaces() - # If there's a ':' after the name - the next identifier is type - if r.curr() == ':': - r.step() - arg_type = r.fetch_identifier() - # If there's a comma - there's one more argument - # else no arguments anymore - if r.curr() == ',': - r.step() - identifier = r.fetch_identifier() - else: - identifier = '' - args.append((arg_name, arg_type)) - # Get to the end of the line and get a comment from the reader - while r.curr() != '': - r.step() - comment = r.comment - # Build the element - return AsmFunction(r.location(), name, comment, calling_convention, - args, used_regs) - - -def get_declarations(asm_file_contents, asm_file_name): - r = AsmReader(asm_file_name) - - while not r.no_lines(): - # Skip leading spaces - r.skip_spaces() - # Skip the line if it's starting with a comment - if r.curr() == ';': - r.nextline() - continue - # Get first word - first_word = "" - while is_id(r.curr()): - first_word += r.step() - # Match macro declaration - if first_word == "macro": - macro = parse_after_macro(r) - elements.append(macro) - id_add_kind(macro.name, ID_KIND_MACRO_NAME) - # Match structure declaration - elif first_word == "struct": - struct = parse_after_struct(r) - elements.append(struct) - id_add_kind(struct.name, ID_KIND_STRUCT_NAME) - # Match function definition - elif first_word == "proc": - proc = parse_after_proc(r) - elements.append(proc) - elif first_word == 'format': - # Skip the format directive - pass - elif first_word == 'include': - # Skip the include directive - pass - elif first_word == 'if': - # Skip the conditional directive - pass - elif first_word == 'repeat': - # Skip the repeat directive - pass - elif first_word == 'purge': - while True: - # Skip spaces after the 'purge' keyword or after - # the comma what separated the previous macro name - r.skip_spaces() - # Get the purged macro name - name = '' - while is_id(r.curr()): - name += r.step() - # Remove the purged macro from the macro names list - try: - id_remove_kind(name, ID_KIND_MACRO_NAME) - except: - pass - # Skip spaces after the name - r.skip_spaces() - # If it's comma (',') after then that's not the last purged - # macro, continue purging - if r.curr() == ',': - r.step() - continue - # Here we purged all the macros should be purged - break - # Match label or a variable - elif len(first_word) != 0: - # Skip spaces after the identifier - r.skip_spaces() - # Match a variable - var = parse_variable(r, first_word) - if type(var) == AsmVariable: - elements.append(var) - # If it wasn't a variable but there was an identifier - # Maybe that's a label and the identifier is the label name - # The parse_variable returns the first found or supplied identifier - # In this case it returns the first_word which is supplied - # If it didn't match a type identifier after the word - elif type(var) == str: - name = var - # Match label beginning (':' after name) - if r.curr() == ':': - # Get to the end of the line and - # get the coment from the reader - while r.curr() != '': - r.step() - comment = r.comment - # Only handle non-local labels - if name[0] != '.' and name != "@@" and name != "$Revision": - # Treate the label as function if there's @return or - # @param in its comment. Othervice it's just a variable - # with type `label` in generated doxygen C - if '@return' in comment or '@param' in comment: - element = AsmFunction(r.location(), name, comment, - '', [], []) - else: - element = AsmLabel(r.location(), name, comment) - elements.append(element) - elif r.curr() == '=': - # Save the identifier as a set constant - id_add_kind(first_word, ID_KIND_SET_CONSTANT) - elif type(var) == tuple: - (word_one, word_two) = var - if word_two == 'equ': - # Save the identifier as an equated constant - id_add_kind(word_one, ID_KIND_EQUATED_CONSTANT) - r.nextline() - - -def it_neds_to_be_parsed(source_file): - # If there's no symbols file saved - parse it anyway - # cause we need to create the symbols file and use it - # if we gonna generate proper doxygen - if not os.path.isfile('asmxygen.elements.pickle'): - return True - dest = doxygen_src_path + '/' + source_file - # If there's no the doxygen file it should be compiled to - # then yes, we should compile it to doxygen - if not os.path.isfile(dest): - return True - source_change_time = os.path.getmtime(source_file) - dest_change_file = os.path.getmtime(dest) - # If the source is newer than the doxygen it was compiled to - # then the source should be recompiled (existing doxygen is old) - if source_change_time > dest_change_file: - return True - return False - - -def handle_file(handled_files, asm_file_name, subdir="."): - global elements - # Canonicalize the file path and get it relative to cwd - cwd = os.path.abspath(os.path.dirname(sys.argv[0])) - asm_file_name = os.path.realpath(asm_file_name) - asm_file_name = asm_file_name[len(cwd) + 1:] - # If it's lang.inc - skip it - if asm_file_name == 'lang.inc': - return - # If the file was handled in this execution before - skip it - if asm_file_name in handled_files: - return - # Say that the file was handled in this execution - handled_files.append(asm_file_name) - # Check if the file should be parsed - # (if it was modified or wasn't parsed yet) - should_get_declarations = True - if not it_neds_to_be_parsed(asm_file_name): - print(f"Skipping {asm_file_name} (already newest)") - should_get_declarations = False - else: - print(f"Handling {asm_file_name}") - # Remove elements parsed from this file before if any - elements_to_remove = [ - x for x in elements if x.location.split(':')[0] == asm_file_name - ] - elements = [ - x for x in elements if x.location.split(':')[0] != asm_file_name - ] - # Forget types of identifiers of names of the removed elements - for element in elements_to_remove: - if type(element) == AsmStruct: - id_remove_kind(element.name, ID_KIND_STRUCT_NAME) - elif type(element) == AsmMacro: - id_remove_kind(element.name, ID_KIND_MACRO_NAME) - # Read the source - asm_file_contents = open(asm_file_name, "r", encoding="utf-8").read() - # Find includes, fix their paths and handle em recoursively - includes = re.findall(r'^include (["\'])(.*)\1', asm_file_contents, - flags=re.MULTILINE) - for include in includes: - include = include[1].replace('\\', '/') - full_path = subdir + '/' + include - # If the path isn't valid, maybe that's not relative path - if not os.path.isfile(full_path): - full_path = include - new_subdir = full_path.rsplit('/', 1)[0] - handle_file(handled_files, full_path, new_subdir) - # Only collect declarations from the file if it wasn't parsed before - if should_get_declarations and not clean_generated_stuff: - get_declarations(asm_file_contents, asm_file_name) - -if __name__ == "__main__": - link_root = "http://websvn.kolibrios.org/filedetails.php" - link_root += "?repname=Kolibri+OS&path=/kernel/trunk" - - # Dict where an identifier is assicoated with a string - # The string contains characters specifying flags - # Available flags: - # k - Keyword - # m - Macro name - # t - fasm data Type name (db, rq, etc.) - # s - Struct type name - # e - equated constant (name equ value) - # = - set constants (name = value) - ID_KIND_KEYWORD = 'k' - ID_KIND_MACRO_NAME = 'm' - ID_KIND_FASM_TYPE = 't' - ID_KIND_STRUCT_NAME = 's' - ID_KIND_EQUATED_CONSTANT = 'e' - ID_KIND_SET_CONSTANT = '=' - id2kind = {} - - for keyword in keywords: - id_add_kind(keyword, ID_KIND_KEYWORD) - - for fasm_type in fasm_types: - id_add_kind(fasm_type, ID_KIND_FASM_TYPE) - - # Warning list - warnings = "" - - # Parameters - # Path to doxygen folder to make doxygen files in: -o - doxygen_src_path = 'docs/doxygen' - # Remove generated doxygen files: --clean - clean_generated_stuff = False - # Dump all defined symbols: --dump - dump_symbols = False - # Print symbol stats: --stats - print_stats = False - # Do not write warnings file: --nowarn - enable_warnings = True - - # Parse arguments - parser = argparse.ArgumentParser() - parser.add_argument("-o", help="Doxygen output folder") - parser.add_argument("--clean", - help="Remove generated files", - action="store_true") - parser.add_argument("--dump", - help="Dump all defined symbols", - action="store_true") - parser.add_argument("--stats", - help="Print symbol stats", - action="store_true") - parser.add_argument("--nowarn", - help="Do not write warnings file", - action="store_true") - parser.add_argument("--noemit", - help="Do not emit doxygen files (for testing)", - action="store_true") - parser.add_argument("--debug", - help="Show hashes of files (for testing)", - action="store_true") - args = parser.parse_args() - doxygen_src_path = args.o if args.o else 'docs/doxygen' - clean_generated_stuff = args.clean - dump_symbols = args.dump - print_stats = args.stats - enable_warnings = not args.nowarn - noemit = args.noemit - debug_mode = args.debug - - # Variables, functions, labels, macros, structure types - elements = [] - created_files = [] - kernel_files = [] - output_files = {} # If --debug then all the files are written here - - # Load remembered list of symbols - if os.path.isfile('asmxygen.elements.pickle'): - print('Reading existing dump of symbols') - pickle_file = open('asmxygen.elements.pickle', 'rb') - (elements, id2kind) = pickle.load(pickle_file) - pickle_file.close() - - handle_file(kernel_files, "./kernel.asm") - - if dump_symbols: - stdout = sys.stdout - sys.stdout = open('asmxygen.dump.txt', 'w', encoding='utf-8') - for asm_element in elements: - asm_element.dump() - sys.stdout = stdout - - if clean_generated_stuff: - kernel_files_set = set(kernel_files) - for file in kernel_files: - doxygen_file = f"{doxygen_src_path}/{file}" - if (os.path.isfile(doxygen_file)): - print(f"Removing {file}... ", end='') - os.remove(doxygen_file) - print("Done.") - elif not noemit: - print(f"Writing doumented sources to {doxygen_src_path}") - - i = 0 - new_elements = [x for x in elements if x.new] - for element in new_elements: - counter = f"[{i + 1}/{len(new_elements)}]" - print(f"{counter} Emitting {element.name} from {element.location}") - element.emit(doxygen_src_path) - i += 1 - - print(f"Writing dump of symbols to asmxygen.elements.pickle") - - # Now when the new elements already was written, there's no new - # elements anymore - for element in elements: - element.new = False - pickle_file = open('asmxygen.elements.pickle', 'wb') - pickle.dump((elements, id2kind), pickle_file) - pickle_file.close() - - if print_stats: - var_count = 0 - mac_count = 0 - lab_count = 0 - fun_count = 0 - uni_count = 0 - str_count = 0 - for element in elements: - if type(element) == AsmVariable: - var_count += 1 - elif type(element) == AsmMacro: - mac_count += 1 - elif type(element) == AsmLabel: - lab_count += 1 - elif type(element) == AsmFunction: - fun_count += 1 - elif type(element) == AsmUnion: - uni_count += 1 - elif type(element) == AsmStruct: - str_count += 1 - print(f'Parsed variable count: {var_count}') - print(f'Parsed macro count: {mac_count}') - print(f'Parsed label count: {lab_count}') - print(f'Parsed function count: {fun_count}') - print(f'Parsed union type count: {uni_count}') - print(f'Parsed structure type count: {str_count}') - - if enable_warnings: - open('asmxygen.txt', "w", encoding="utf-8").write(warnings) - - if debug_mode: - hash_per_file = "" - for file in output_files: - h = hashlib.sha1(bytes(output_files[file], "ascii")).hexdigest() - hash_per_file += f"{file}: {h}\n" - if not os.path.exists("asmxygen_hash_per_file.txt"): - open("asmxygen_hash_per_file.txt", "w").write(hash_per_file) - print("NEW") - else: - reference_hash_per_file = open("asmxygen_hash_per_file.txt").read() - if reference_hash_per_file != hash_per_file: - diffs = difflib.ndiff(reference_hash_per_file, hash_per_file) - print(''.join(diffs)) - else: - print("SUCCESS") +import re +import os +import argparse +import sys +import pickle +import hashlib +import difflib + +# fasm keywords +keywords = [ + "align", "equ", "org", "while", "load", "store", "times", "repeat", + "display", "err", "assert", "if", "aaa", "aad", "aam", "aas", "adc", + "add", "addpd", "addps", "addsd", "addss", "addsubpd", "addsubps", "adox", + "aesdeclast", "aesenc", "aesenclast", "aesimc", "aeskeygenassist", "and", + "andnpd", "andnps", "andpd", "andps", "arpl", "bextr", "blendpd", + "blendvpd", "blendvps", "blsi", "blsmsk", "blsr", "bndcl", "bndcn", + "bndldx", "bndmk", "bndmov", "bndstx", "bound", "bsf", "bsr", "bswap", + "btc", "btr", "bts", "bzhi", "call", "cbw", "cdq", "cdqe", "clac", "clc", + "cldemote", "clflush", "clflushopt", "cli", "clts", "clwb", "cmc", "cmova", + "cmovb", "cmovbe", "cmovc", "cmove", "cmovg", "cmovge", "cmovl", "cmovle", + "cmovnae", "cmovnb", "cmovnbe", "cmovnc", "cmovne", "cmovng", "cmovnge", + "cmovnle", "cmovno", "cmovnp", "cmovns", "cmovnz", "cmovo", "cmovp", + "cmovpo", "cmovs", "cmovz", "cmp", "cmppd", "cmpps", "cmps", "cmpsb", + "cmpsd", "cmpsq", "cmpss", "cmpsw", "cmpxchg", "cmpxchg16b", "cmpxchg8b", + "comiss", "cpuid", "cqo", "crc32", "cvtdq2pd", "cvtdq2ps", "cvtpd2dq", + "cvtpd2ps", "cvtpi2pd", "cvtpi2ps", "cvtps2dq", "cvtps2pd", "cvtps2pi", + "cvtsd2ss", "cvtsi2sd", "cvtsi2ss", "cvtss2sd", "cvtss2si", "cvttpd2dq", + "cvttps2dq", "cvttps2pi", "cvttsd2si", "cvttss2si", "cwd", "cwde", "daa", + "dec", "div", "divpd", "divps", "divsd", "divss", "dppd", "dpps", "emms", + "extractps", "f2xm1", "fabs", "fadd", "faddp", "fbld", "fbstp", "fchs", + "fcmova", "fcmovae", "fcmovb", "fcmovbe", "fcmovc", "fcmove", "fcmovg", + "fcmovl", "fcmovle", "fcmovna", "fcmovnae", "fcmovnb", "fcmovnbe", + "fcmovne", "fcmovng", "fcmovnge", "fcmovnl", "fcmovnle", "fcmovno", + "fcmovns", "fcmovnz", "fcmovo", "fcmovp", "fcmovpe", "fcmovpo", "fcmovs", + "fcom", "fcomi", "fcomip", "fcomp", "fcompp", "fcos", "fdecstp", "fdiv", + "fdivr", "fdivrp", "ffree", "fiadd", "ficom", "ficomp", "fidiv", "fidivr", + "fimul", "fincstp", "finit", "fist", "fistp", "fisttp", "fisub", "fisubr", + "fld1", "fldcw", "fldenv", "fldl2e", "fldl2t", "fldlg2", "fldln2", "fldpi", + "fmul", "fmulp", "fnclex", "fninit", "fnop", "fnsave", "fnstcw", "fnstenv", + "fpatan", "fprem", "fprem1", "fptan", "frndint", "frstor", "fsave", + "fsin", "fsincos", "fsqrt", "fst", "fstcw", "fstenv", "fstp", "fstsw", + "fsubp", "fsubr", "fsubrp", "ftst", "fucom", "fucomi", "fucomip", "fucomp", + "fwait", "fxam", "fxch", "fxrstor", "fxsave", "fxtract", "fyl2x", + "gf2p8affineinvqb", "gf2p8affineqb", "gf2p8mulb", "haddpd", "haddps", + "hsubpd", "hsubps", "idiv", "imul", "in", "inc", "ins", "insb", "insd", + "insw", "int", "int1", "int3", "into", "invd", "invlpg", "invpcid", "iret", + "jmp", "ja", "jae", "jb", "jbe", "jc", "jcxz", "jecxz", "je", "jg", "jge", + "jle", "jna", "jnae", "jnb", "jnbe", "jnc", "jne", "jng", "jnge", "jnl", + "jno", "jnp", "jns", "jnz", "jo", "jp", "jpe", "jpo", "js", "jz", "kaddb", + "kaddq", "kaddw", "kandb", "kandd", "kandnb", "kandnd", "kandnq", "kandnw", + "kandw", "kmovb", "kmovd", "kmovq", "kmovw", "knotb", "knotd", "knotq", + "korb", "kord", "korq", "kortestb", "kortestd", "kortestq", "kortestw", + "kshiftlb", "kshiftld", "kshiftlq", "kshiftlw", "kshiftrb", "kshiftrd", + "kshiftrw", "ktestb", "ktestd", "ktestq", "ktestw", "kunpckbw", "kunpckdq", + "kxnorb", "kxnord", "kxnorq", "kxnorw", "kxorb", "kxord", "kxorq", "kxorw", + "lar", "lddqu", "ldmxcsr", "lds", "lea", "leave", "les", "lfence", "lfs", + "lgs", "lidt", "lldt", "lmsw", "lock", "lods", "lodsb", "lodsd", "lodsq", + "loop", "loopa", "loopae", "loopb", "loopbe", "loopc", "loope", "loopg", + "loopl", "loople", "loopna", "loopnae", "loopnb", "loopnbe", "loopnc", + "loopng", "loopnge", "loopnl", "loopnle", "loopno", "loopnp", "loopns", + "loopo", "loopp", "looppe", "looppo", "loops", "loopz", "lsl", "lss", + "lzcnt", "maskmovdqu", "maskmovq", "maxpd", "maxps", "maxsd", "maxss", + "minpd", "minps", "minsd", "minss", "monitor", "mov", "movapd", "movaps", + "movd", "movddup", "movdir64b", "movdiri", "movdq2q", "movdqa", "movdqu", + "movhpd", "movhps", "movlhps", "movlpd", "movlps", "movmskpd", "movmskps", + "movntdqa", "movnti", "movntpd", "movntps", "movntq", "movq", "movq", + "movs", "movsb", "movsd", "movsd", "movshdup", "movsldup", "movsq", + "movsw", "movsx", "movsxd", "movupd", "movups", "movzx", "mpsadbw", "mul", + "mulps", "mulsd", "mulss", "mulx", "mwait", "neg", "nop", "not", "or", + "orps", "out", "outs", "outsb", "outsd", "outsw", "pabsb", "pabsd", + "pabsw", "packssdw", "packsswb", "packusdw", "packuswb", "paddb", "paddd", + "paddsb", "paddsw", "paddusb", "paddusw", "paddw", "palignr", "pand", + "pause", "pavgb", "pavgw", "pblendvb", "pblendw", "pclmulqdq", "pcmpeqb", + "pcmpeqq", "pcmpeqw", "pcmpestri", "pcmpestrm", "pcmpgtb", "pcmpgtd", + "pcmpgtw", "pcmpistri", "pcmpistrm", "pdep", "pext", "pextrb", "pextrd", + "pextrw", "phaddd", "phaddsw", "phaddw", "phminposuw", "phsubd", "phsubsw", + "pinsrb", "pinsrd", "pinsrq", "pinsrw", "pmaddubsw", "pmaddwd", "pmaxsb", + "pmaxsq", "pmaxsw", "pmaxub", "pmaxud", "pmaxuq", "pmaxuw", "pminsb", + "pminsq", "pminsw", "pminub", "pminud", "pminuq", "pminuw", "pmovmskb", + "pmovzx", "pmuldq", "pmulhrsw", "pmulhuw", "pmulhw", "pmulld", "pmullq", + "pmuludq", "pop", "popa", "popad", "popcnt", "popf", "popfd", "popfq", + "prefetchw", "prefetchh", "psadbw", "pshufb", "pshufd", "pshufhw", + "pshufw", "psignb", "psignd", "psignw", "pslld", "pslldq", "psllq", + "psrad", "psraq", "psraw", "psrld", "psrldq", "psrlq", "psrlw", "psubb", + "psubq", "psubsb", "psubsw", "psubusb", "psubusw", "psubw", "ptest", + "punpckhbw", "punpckhdq", "punpckhqdq", "punpckhwd", "punpcklbw", + "punpcklqdq", "punpcklwd", "push", "pushw", "pushd", "pusha", "pushad", + "pushfd", "pushfq", "pxor", "rcl", "rcpps", "rcpss", "rcr", "rdfsbase", + "rdmsr", "rdpid", "rdpkru", "rdpmc", "rdrand", "rdseed", "rdtsc", "rdtscp", + "repe", "repne", "repnz", "repz", "ret", "rol", "ror", "rorx", "roundpd", + "roundsd", "roundss", "rsm", "rsqrtps", "rsqrtss", "sahf", "sal", "sar", + "sbb", "scas", "scasb", "scasd", "scasw", "seta", "setae", "setb", "setbe", + "sete", "setg", "setge", "setl", "setle", "setna", "setnae", "setnb", + "setnc", "setne", "setng", "setnge", "setnl", "setnle", "setno", "setnp", + "setnz", "seto", "setp", "setpe", "setpo", "sets", "setz", "sfence", + "sha1msg1", "sha1msg2", "sha1nexte", "sha1rnds4", "sha256msg1", + "sha256rnds2", "shl", "shld", "shlx", "shr", "shrd", "shrx", "shufpd", + "sidt", "sldt", "smsw", "sqrtpd", "sqrtps", "sqrtsd", "sqrtss", "stac", + "std", "sti", "stmxcsr", "stos", "stosb", "stosd", "stosq", "stosw", "str", + "subpd", "subps", "subsd", "subss", "swapgs", "syscall", "sysenter", + "sysret", "test", "tpause", "tzcnt", "ucomisd", "ucomiss", "ud", + "umwait", "unpckhpd", "unpckhps", "unpcklpd", "unpcklps", "valignd", + "vblendmpd", "vblendmps", "vbroadcast", "vcompresspd", "vcompressps", + "vcvtpd2udq", "vcvtpd2uqq", "vcvtph2ps", "vcvtps2ph", "vcvtps2qq", + "vcvtps2uqq", "vcvtqq2pd", "vcvtqq2ps", "vcvtsd2usi", "vcvtss2usi", + "vcvttpd2udq", "vcvttpd2uqq", "vcvttps2qq", "vcvttps2udq", "vcvttps2uqq", + "vcvttss2usi", "vcvtudq2pd", "vcvtudq2ps", "vcvtuqq2pd", "vcvtuqq2ps", + "vcvtusi2ss", "vdbpsadbw", "verr", "verw", "vexpandpd", "vexpandps", + "vextractf32x4", "vextractf32x8", "vextractf64x2", "vextractf64x4", + "vextracti32x4", "vextracti32x8", "vextracti64x2", "vextracti64x4", + "vfixupimmps", "vfixupimmsd", "vfixupimmss", "vfmadd132pd", "vfmadd132ps", + "vfmadd132ss", "vfmadd213pd", "vfmadd213ps", "vfmadd213sd", "vfmadd213ss", + "vfmadd231ps", "vfmadd231sd", "vfmadd231ss", "vfmaddsub132pd", + "vfmaddsub213pd", "vfmaddsub213ps", "vfmaddsub231pd", "vfmaddsub231ps", + "vfmsub132ps", "vfmsub132sd", "vfmsub132ss", "vfmsub213pd", "vfmsub213ps", + "vfmsub213ss", "vfmsub231pd", "vfmsub231ps", "vfmsub231sd", "vfmsub231ss", + "vfmsubadd132ps", "vfmsubadd213pd", "vfmsubadd213ps", "vfmsubadd231pd", + "vfnmadd132pd", "vfnmadd132ps", "vfnmadd132sd", "vfnmadd132ss", + "vfnmadd213ps", "vfnmadd213sd", "vfnmadd213ss", "vfnmadd231pd", + "vfnmadd231sd", "vfnmadd231ss", "vfnmsub132pd", "vfnmsub132ps", + "vfnmsub132ss", "vfnmsub213pd", "vfnmsub213ps", "vfnmsub213sd", + "vfnmsub231pd", "vfnmsub231ps", "vfnmsub231sd", "vfnmsub231ss", + "vfpclassps", "vfpclasssd", "vfpclassss", "vgatherdpd", "vgatherdpd", + "vgatherdps", "vgatherqpd", "vgatherqpd", "vgatherqps", "vgatherqps", + "vgetexpps", "vgetexpsd", "vgetexpss", "vgetmantpd", "vgetmantps", + "vgetmantss", "vinsertf128", "vinsertf32x4", "vinsertf32x8", + "vinsertf64x4", "vinserti128", "vinserti32x4", "vinserti32x8", + "vinserti64x4", "vmaskmov", "vmovdqa32", "vmovdqa64", "vmovdqu16", + "vmovdqu64", "vmovdqu8", "vpblendd", "vpblendmb", "vpblendmd", "vpblendmq", + "vpbroadcast", "vpbroadcastb", "vpbroadcastd", "vpbroadcastm", + "vpbroadcastw", "vpcmpb", "vpcmpd", "vpcmpq", "vpcmpub", "vpcmpud", + "vpcmpuw", "vpcmpw", "vpcompressd", "vpcompressq", "vpconflictd", + "vperm2f128", "vperm2i128", "vpermb", "vpermd", "vpermi2b", "vpermi2d", + "vpermi2ps", "vpermi2q", "vpermi2w", "vpermilpd", "vpermilps", "vpermpd", + "vpermq", "vpermt2b", "vpermt2d", "vpermt2pd", "vpermt2ps", "vpermt2q", + "vpermw", "vpexpandd", "vpexpandq", "vpgatherdd", "vpgatherdd", + "vpgatherdq", "vpgatherqd", "vpgatherqd", "vpgatherqq", "vpgatherqq", + "vplzcntq", "vpmadd52huq", "vpmadd52luq", "vpmaskmov", "vpmovb2m", + "vpmovdb", "vpmovdw", "vpmovm2b", "vpmovm2d", "vpmovm2q", "vpmovm2w", + "vpmovqb", "vpmovqd", "vpmovqw", "vpmovsdb", "vpmovsdw", "vpmovsqb", + "vpmovsqw", "vpmovswb", "vpmovusdb", "vpmovusdw", "vpmovusqb", "vpmovusqd", + "vpmovuswb", "vpmovw2m", "vpmovwb", "vpmultishiftqb", "vprold", "vprolq", + "vprolvq", "vprord", "vprorq", "vprorvd", "vprorvq", "vpscatterdd", + "vpscatterqd", "vpscatterqq", "vpsllvd", "vpsllvq", "vpsllvw", "vpsravd", + "vpsravw", "vpsrlvd", "vpsrlvq", "vpsrlvw", "vpternlogd", "vpternlogq", + "vptestmd", "vptestmq", "vptestmw", "vptestnmb", "vptestnmd", "vptestnmq", + "vrangepd", "vrangeps", "vrangesd", "vrangess", "vrcp14pd", "vrcp14ps", + "vrcp14ss", "vreducepd", "vreduceps", "vreducesd", "vreducess", + "vrndscaleps", "vrndscalesd", "vrndscaless", "vrsqrt14pd", "vrsqrt14ps", + "vrsqrt14ss", "vscalefpd", "vscalefps", "vscalefsd", "vscalefss", + "vscatterdps", "vscatterqpd", "vscatterqps", "vshuff32x4", "vshuff64x2", + "vshufi64x2", "vtestpd", "vtestps", "vzeroall", "vzeroupper", "wait", + "wrfsbase", "wrgsbase", "wrmsr", "wrpkru", "xabort", "xacquire", "xadd", + "xchg", "xend", "xgetbv", "xlat", "xlatb", "xor", "xorpd", "xorps", + "xrstor", "xrstors", "xsave", "xsavec", "xsaveopt", "xsaves", "xsetbv", +] + +fasm_types = [ + "db", "rb", + "dw", "rw", + "dd", "rd", + "dp", "rp", + "df", "rf", + "dq", "rq", + "dt", "rt", + "du", +] + + +# Add kind flag to identifier in id2kind +def id_add_kind(identifier, kind): + if identifier not in id2kind: + id2kind[identifier] = '' + id2kind[identifier] += kind + + +# Remove kind flag of identifier in id2kind +def id_remove_kind(identifier, kind): + if identifier in id2kind: + if kind in id2kind[identifier]: + id2kind[identifier] = id2kind[identifier].replace(kind, '') + + +# Get kind of an identifier +def id_get_kind(identifier): + if identifier in id2kind: + return id2kind[identifier] + else: + return '' + + +class LegacyAsmReader: + def __init__(self, file): + self.file = file + self.lines = open(file, "r", encoding="utf-8").readlines() + self.line_idx = 0 + self.i = 0 + + def currline(self): + return self.lines[self.line_idx] + + def curr(self): + try: + return self.lines[self.line_idx][self.i] + except: + return '' + + def step(self): + c = self.curr() + self.i += 1 + # Wrap the line if '\\' followed by whitespaces and/or comment + while self.curr() == '\\': + i_of_backslash = self.i + self.i += 1 + while self.curr().isspace(): + self.i += 1 + if self.curr() == ';' or self.curr() == '': + self.line_idx += 1 + self.i = 0 + else: + # There's something other than a comment after the backslash + # So don't interpret the backslash as a line wrap + self.i = i_of_backslash + break + return c + + def nextline(self): + c = self.curr() + while c != '': + c = self.step() + self.line_idx += 1 + self.i = 0 + + def no_lines(self): + if self.line_idx >= len(self.lines): + return True + return False + + def location(self): + return f"{self.file}:{self.line_idx + 1}" + + def skip_spaces(self): + while self.curr().isspace(): + self.step() + + +class AsmReaderRecognizingStrings(LegacyAsmReader): + def __init__(self, file): + super().__init__(file) + self.in_string = None + self.should_recognize_strings = True + + def step(self): + c = super().step() + if self.should_recognize_strings and (c == '"' or c == "'"): + # If just now we was at the double or single quotation mark + # and we aren't in a string yet then say + # "we are in a string openned with this quotation mark now" + if self.in_string is None: + self.in_string = c + # If just now we was at the double or single quotation mark + # and we are in the string entered with the same quotation mark + # then say "we aren't in a string anymore" + elif self.in_string == c: + self.in_string = None + return c + + +class AsmReaderReadingComments(AsmReaderRecognizingStrings): + def __init__(self, file): + super().__init__(file) + self.status = dict() + self.status_reset() + self.comment = '' + + def status_reset(self): + # If the line has non-comment code + self.status_has_code = False + # If the line has a comment at the end + self.status_has_comment = False + # Let it recognize strings further, we are definitely out of a comment + self.should_recognize_strings = True + + def status_set_has_comment(self): + self.status_has_comment = True + # Don't let it recognize strings cause we are in a comment now + self.should_recognize_strings = False + + def status_set_has_code(self): + self.status_has_code = True + + def update_status(self): + # If we aren't in a comment and we aren't in a string - + # say we are now in a comment if ';' met + if (not self.status_has_comment and + not self.in_string and + self.curr() == ';'): + self.status_set_has_comment() + # Else if we are in a comment - collect the comment + elif self.status_has_comment: + self.comment += self.curr() + # Else if there's some non-whitespace character out of a comment + # then the line has code + elif not self.status_has_comment and not self.curr().isspace(): + self.status_set_has_code() + + def step(self): + # Get to the next character + c = super().step() + # Update status of the line according to the next character + self.update_status() + return c + + def nextline(self): + prev_line = self.currline() + super().nextline() + # If the line we leave was not a comment-only line + # then forget the collected comment + # Otherwise the collected comment should be complemented by + # comment from next line in step() + if self.status_has_code: + # But we should preserve comment for the next line + # If previous line set align (cause many functions re documented + # right before align set, not before their labels) + if not prev_line.startswith("align "): + self.comment = '' + # Reset the line status (now it's the status of the new line) + self.status_reset() + # Set new status for this line according to the + # first character in the line + self.update_status() + + +class AsmReaderFetchingIdentifiers(AsmReaderReadingComments): + def __init__(self, file): + super().__init__(file) + + def fetch_identifier(self): + self.skip_spaces() + result = '' + while is_id(self.curr()): + result += self.step() + return result + + +class AsmReader(AsmReaderFetchingIdentifiers): + def __init__(self, file): + super().__init__(file) + + +def append_file(full_path, contents): + if debug_mode: + if full_path not in output_files: + output_files[full_path] = "" + output_files[full_path] += contents + else: + f = open(full_path, "a") + f.write(contents) + f.close() + + +class AsmElement: + def __init__(self, location, name, comment): + global warnings + + # If the element was constructed during this execution then + # the element is new + self.new = True + self.location = location + self.file = self.location.split(':')[0].replace('\\', '/') + self.line = self.location.split(':')[1] + self.name = name + self.comment = comment + + if self.comment == '': + warnings += f'{self.location}: Undocumented element\n' + + def dump(self): + print(f"\n{self.location}: {self.name}") + print(f"{self.comment}") + + def emit(self, dest, doxycomment='', declaration=''): + # Do not emit anything if the symbol is marked as hidden in its comment + if '@dont_give_a_doxygen' in self.comment: + return + + global warnings + # Redefine default declaration + if declaration == '': + declaration = f'#define {self.name}' + # Check doxycomment + if not doxycomment.endswith('\n'): + doxycomment += '\n' + if doxycomment.split('@brief ')[1][0].islower(): + warnings += (f"{self.location}: Brief comment starting from " + + "lowercase\n") + # Build contents to emit + contents = '' + contents += '/**\n' + contents += doxycomment + contents += (f"@par Source\n" + + f"{self.file}:{self.line}\n") + contents += '*/\n' + contents += declaration + contents += '\n\n' + # Get path to file to emit this + full_path = dest + '/' + self.file + # Remove the file on first access if it was + # created by previous generation + if full_path not in created_files: + if os.path.isfile(full_path): + os.remove(full_path) + created_files.append(full_path) + # Create directories need for the file + os.makedirs(os.path.dirname(full_path), exist_ok=True) + contents = ''.join([i if ord(i) < 128 else '?' for i in contents]) + + append_file(full_path, contents) + + +class AsmVariable(AsmElement): + def __init__(self, location, name, comment, type, init): + super().__init__(location, name, comment) + self.type = type + self.init = init + + def dump(self): + super().dump() + print(f"(Variable)\n---") + + def emit(self, dest): + # Build doxycomment specific for the variable + doxycomment = '' + doxycomment += self.comment + if '@brief' not in doxycomment: + doxycomment = '@brief ' + doxycomment + doxycomment += (f"@par Initial value\n" + + f"{self.init}\n") + # Build the declaration + name = self.name.replace(".", "_") + var_type = self.type.replace(".", "_") + declaration = f"{var_type} {name};" + # Emit this + super().emit(dest, doxycomment, declaration) + + +class AsmFunction(AsmElement): + def __init__(self, location, name, comment, calling_convention, + args, used_regs): + super().__init__(location, name, comment) + self.calling_convention = calling_convention + self.args = args + self.used_regs = used_regs + + def dump(self): + super().dump() + print(f"(Function)\n---") + + def emit(self, dest): + # Build doxycomment specific for the variable + doxycomment = '' + doxycomment += self.comment + if '@brief' not in doxycomment: + doxycomment = '@brief ' + doxycomment + # If there was no arguments, maybe that's just a label + # then parse parameters from its comment + if len(self.args) == 0 and '@param' in self.comment: + i = 0 + while '@param' in self.comment[i:]: + i = self.comment.index('@param', i) + # Skip '@param' + i += len('@param') + # Skip spaces after '@param' + while self.comment[i].isspace(): + i += 1 + # Get the parameter name + name = '' + while is_id(self.comment[i]): + name += self.comment[i] + i += 1 + # Save the parameter + self.args.append((name, 'arg_t')) + # Build the arg list for declaration + arg_list = '(' + if len(self.args) > 0: + argc = 0 + for arg in self.args: + if argc != 0: + arg_list += ", " + arg_list += f"{arg[1]} {arg[0]}" + argc += 1 + arg_list += ')' + # Build the declaration + name = self.name.replace(".", "_") + declaration = f"void {name}{arg_list};" + # Emit this + super().emit(dest, doxycomment, declaration) + + +class AsmLabel(AsmElement): + def __init__(self, location, name, comment): + super().__init__(location, name, comment) + + def dump(self): + super().dump() + print(f"(Label)\n---") + + def emit(self, dest): + # Build doxycomment specific for the variable + doxycomment = '' + doxycomment += self.comment + if '@brief' not in doxycomment: + doxycomment = '@brief ' + doxycomment + # Build the declaration + name = self.name.replace(".", "_") + declaration = f"label {name};" + # Emit this + super().emit(dest, doxycomment, declaration) + + +class AsmMacro(AsmElement): + def __init__(self, location, name, comment, args): + super().__init__(location, name, comment) + self.args = args + + def dump(self): + super().dump() + print(f"(Macro)\n---") + + def emit(self, dest): + # Construct arg list without '['s, ']'s and '*'s + args = [arg for arg in self.args if arg not in "[]*"] + # Construct C-like arg list + arg_list = "" + if len(args) > 0: + arg_list += '(' + argc = 0 + for arg in args: + if argc != 0: + arg_list += ", " + arg_list += arg + argc += 1 + arg_list += ')' + # Build doxycomment + doxycomment = '' + doxycomment += self.comment + if '@brief' not in doxycomment: + doxycomment = '@brief ' + doxycomment + # Build declaration + declaration = f"#define {self.name}{arg_list}" + # Emit this + super().emit(dest, doxycomment, declaration) + + +class AsmStruct(AsmElement): + def __init__(self, location, name, comment, members): + super().__init__(location, name, comment) + self.members = members + + def dump(self): + super().dump() + print(f"(Struct)\n---") + + def emit(self, dest): + # Build doxycomment + doxycomment = '' + doxycomment += self.comment + if '@brief' not in doxycomment: + doxycomment = '@brief ' + doxycomment + doxycomment += '\n' + # Build declaration + declaration = f"struct {self.name}" + " {\n" + for member in self.members: + if type(member) == AsmVariable: + declaration += (f'\t{member.type} {member.name}; ' + + f'/**< {member.comment} */\n') + declaration += '};' + # Emit this + super().emit(dest, doxycomment, declaration) + + +class AsmUnion(AsmElement): + def __init__(self, location, name, comment, members): + super().__init__(location, name, comment) + self.members = members + + def dump(self): + super().dump() + print(f"(Union)\n---") + + def emit(self, dest): + # Build doxycomment + doxycomment = '' + doxycomment += self.comment + if '@brief' not in doxycomment: + doxycomment = '@brief ' + doxycomment + # Build declaration + declaration = f"union {self.name}" + " {};" + # Emit this + super().emit(dest, doxycomment, declaration) + + +class VariableNameIsMacroName: + def __init__(self, name): + self.name = name + + +def is_id(c): + return c.isprintable() and c not in "+-/*=<>()[]{};:,|&~#`'\" \n\r\t\v" + + +def is_starts_as_id(s): + return not s[0].isdigit() + + +def parse_after_macro(r): + location = r.location() + + # Skip spaces after the "macro" keyword + r.skip_spaces() + # Read macro name + name = "" + while is_id(r.curr()) or r.curr() == '#': + name += r.step() + # Skip spaces after macro name + r.skip_spaces() + # Find all arguments + args = [] + arg = '' + while r.curr() and r.curr() != ';' and r.curr() != '{': + # Collect identifier + if is_id(r.curr()): + arg += r.step() + # Save the collected identifier + elif r.curr() == ',': + args.append(arg) + arg = '' + r.step() + # Just push the '[' + elif r.curr() == '[': + args.append(r.step()) + # Just push the identifier and get ']' ready to be pushed on next comma + elif r.curr() == ']': + args.append(arg) + arg = r.step() + # Just push the identifier and get '*' ready to be pushed on next comma + elif r.curr() == '*': + args.append(arg) + arg = r.step() + # Just skip whitespaces + elif r.curr().isspace(): + r.step() + # Something unexpected + else: + raise Exception(f"Unexpected symbol '{r.curr()}' " + + f"at index #{r.i} in the macro declaration " + + f"at {location} " + + f"(line: {r.lines[r.line_idx]})\n''") + # Append the last argument + if arg != '': + args.append(arg) + # Skip t spaces after the argument list + r.skip_spaces() + # Get a comment if it is: read till the end of the line and + # get the comment from the reader + while r.curr() != '': + r.step() + comment = r.comment + # Find end of the macro + prev = '' + while True: + if r.curr() == '}' and prev != '\\': + break + elif r.curr() == '': + prev = '' + r.nextline() + continue + prev = r.step() + # Build the output + return AsmMacro(location, name, comment, args) + + +def parse_variable(r, first_word=None): + global warnings + location = r.location() + + # Skip spaces before variable name + r.skip_spaces() + # Get variable name + name = "" + # Read it if it was not supplied + if first_word is None: + while is_id(r.curr()): + name += r.step() + # Or use the supplied one instead + else: + name = first_word + # Check the name + # If it's 0 len, that means threr's something else than an + # identifier at the beginning + if len(name) == 0: + return None + # If it starts from digit or othervice illegally it's illegal + if not is_starts_as_id(name): + return None + # Get kind of the identifier from id2kind table + kind = id_get_kind(name) + # If it's a keyword, that's not a variable declaration + if ID_KIND_KEYWORD in kind: + return None + # If it's a macro name, that's not a variable declaration + if ID_KIND_MACRO_NAME in kind: + return VariableNameIsMacroName(name) + # If it's a datatype or a structure name that's not a + # variable declaration: that's just a data + # don't document just a data for now + if ID_KIND_STRUCT_NAME in kind or ID_KIND_FASM_TYPE in kind: + return None + # Skip spaces before type name + r.skip_spaces() + # Read type name + var_type = "" + while is_id(r.curr()): + var_type += r.step() + # Check the type name + if len(var_type) == 0: + # If there's no type identifier after the name + # maybe the name is something meaningful for the next parser + # return it + return name + # If it starts from digit or othervice illegally it's illegal + if not is_starts_as_id(var_type): + return None + # Get kind of type identifier + type_kind = id_get_kind(var_type) + # If it's a keyword, that's not a variable declaration + # return the two words of the lexical structure + if ID_KIND_KEYWORD in type_kind: + return (name, var_type) + # Skip spaces before the value + r.skip_spaces() + # Read the value until the comment or end of the line + value = "" + while r.curr() != ';' and r.curr() != '' and r.curr() != '\n': + value += r.step() + # Skip spaces after the value + r.skip_spaces() + # Read till end of the line to get a comment from the reader + while r.curr() != '': + r.step() + # Build the result + return AsmVariable(location, name, r.comment, var_type, value) + + +def parse_after_struct(r, as_union=True): + global warnings + location = r.location() + + # Skip spaces after "struct" keyword + r.skip_spaces() + # Read struct name + name = "" + while is_id(r.curr()): + name += r.step() + # Read till end of the line and get the comment from the reader + while r.curr() != '': + r.step() + comment = r.comment + # Get to the next line to parse struct members + r.nextline() + # Parse struct members + members = [] + while True: + r.skip_spaces() + var = parse_variable(r) + if type(var) == AsmVariable: + members.append(var) + elif type(var) == str: + if var == 'union': + # Parse the union as a struct + union = parse_after_struct(r, as_union=True) + members.append(union) + # Skip the ends of the union + r.nextline() + elif r.curr() == ':': + warnings += f"{r.location()}: Skept the label in the struct\n" + else: + raise Exception(f"Garbage in struct member at {location} " + + f" (got '{var}' identifier)") + elif type(var) == VariableNameIsMacroName: + if var.name == 'ends': + break + r.nextline() + # Return the result + if as_union: + return AsmStruct(location, name, comment, members) + else: + return AsmUnion(location, name, comment, members) + + +def parse_after_proc(r): + # Get proc name + name = r.fetch_identifier() + # Next identifier after the proc name + identifier = r.fetch_identifier() + # Check if the id is 'stdcall' or 'c' (calling convention specifier) + # and if so - save the convention and lookup the next identifier + calling_convention = '' + if identifier == 'stdcall' or identifier == 'c': + calling_convention = identifier + # If next is a comma, just skip it + if r.curr() == ',': + r.step() + # Read the next identifier + identifier = r.fetch_identifier() + # Check if the id is 'uses' (used register list specifier) + # and if so save the used register list + used_regs = [] + if identifier == 'uses': + # Read the registers + while True: + reg_name = r.fetch_identifier() + if reg_name != '': + used_regs.append(reg_name) + else: + break + # If next is a comma, just skip it + if r.curr() == ',': + r.step() + # Read the next identifier + identifier = r.fetch_identifier() + # Check if there are argument identifiers + args = [] + while identifier != '': + arg_name = identifier + arg_type = 'arg_t' + # Skip spaces after argument name + r.skip_spaces() + # If there's a ':' after the name - the next identifier is type + if r.curr() == ':': + r.step() + arg_type = r.fetch_identifier() + # If there's a comma - there's one more argument + # else no arguments anymore + if r.curr() == ',': + r.step() + identifier = r.fetch_identifier() + else: + identifier = '' + args.append((arg_name, arg_type)) + # Get to the end of the line and get a comment from the reader + while r.curr() != '': + r.step() + comment = r.comment + # Build the element + return AsmFunction(r.location(), name, comment, calling_convention, + args, used_regs) + + +def get_declarations(asm_file_contents, asm_file_name): + r = AsmReader(asm_file_name) + + while not r.no_lines(): + # Skip leading spaces + r.skip_spaces() + # Skip the line if it's starting with a comment + if r.curr() == ';': + r.nextline() + continue + # Get first word + first_word = "" + while is_id(r.curr()): + first_word += r.step() + # Match macro declaration + if first_word == "macro": + macro = parse_after_macro(r) + elements.append(macro) + id_add_kind(macro.name, ID_KIND_MACRO_NAME) + # Match structure declaration + elif first_word == "struct": + struct = parse_after_struct(r) + elements.append(struct) + id_add_kind(struct.name, ID_KIND_STRUCT_NAME) + # Match function definition + elif first_word == "proc": + proc = parse_after_proc(r) + elements.append(proc) + elif first_word == 'format': + # Skip the format directive + pass + elif first_word == 'include': + # Skip the include directive + pass + elif first_word == 'if': + # Skip the conditional directive + pass + elif first_word == 'repeat': + # Skip the repeat directive + pass + elif first_word == 'purge': + while True: + # Skip spaces after the 'purge' keyword or after + # the comma what separated the previous macro name + r.skip_spaces() + # Get the purged macro name + name = '' + while is_id(r.curr()): + name += r.step() + # Remove the purged macro from the macro names list + try: + id_remove_kind(name, ID_KIND_MACRO_NAME) + except: + pass + # Skip spaces after the name + r.skip_spaces() + # If it's comma (',') after then that's not the last purged + # macro, continue purging + if r.curr() == ',': + r.step() + continue + # Here we purged all the macros should be purged + break + # Match label or a variable + elif len(first_word) != 0: + # Skip spaces after the identifier + r.skip_spaces() + # Match a variable + var = parse_variable(r, first_word) + if type(var) == AsmVariable: + elements.append(var) + # If it wasn't a variable but there was an identifier + # Maybe that's a label and the identifier is the label name + # The parse_variable returns the first found or supplied identifier + # In this case it returns the first_word which is supplied + # If it didn't match a type identifier after the word + elif type(var) == str: + name = var + # Match label beginning (':' after name) + if r.curr() == ':': + # Get to the end of the line and + # get the coment from the reader + while r.curr() != '': + r.step() + comment = r.comment + # Only handle non-local labels + if name[0] != '.' and name != "@@" and name != "$Revision": + # Treate the label as function if there's @return or + # @param in its comment. Othervice it's just a variable + # with type `label` in generated doxygen C + if '@return' in comment or '@param' in comment: + element = AsmFunction(r.location(), name, comment, + '', [], []) + else: + element = AsmLabel(r.location(), name, comment) + elements.append(element) + elif r.curr() == '=': + # Save the identifier as a set constant + id_add_kind(first_word, ID_KIND_SET_CONSTANT) + elif type(var) == tuple: + (word_one, word_two) = var + if word_two == 'equ': + # Save the identifier as an equated constant + id_add_kind(word_one, ID_KIND_EQUATED_CONSTANT) + r.nextline() + + +def it_neds_to_be_parsed(source_file): + # If there's no symbols file saved - parse it anyway + # cause we need to create the symbols file and use it + # if we gonna generate proper doxygen + if not os.path.isfile('asmxygen.elements.pickle'): + return True + dest = doxygen_src_path + '/' + source_file + # If there's no the doxygen file it should be compiled to + # then yes, we should compile it to doxygen + if not os.path.isfile(dest): + return True + source_change_time = os.path.getmtime(source_file) + dest_change_file = os.path.getmtime(dest) + # If the source is newer than the doxygen it was compiled to + # then the source should be recompiled (existing doxygen is old) + if source_change_time > dest_change_file: + return True + return False + + +def handle_file(handled_files, asm_file_name, subdir="."): + global elements + # Canonicalize the file path and get it relative to cwd + cwd = os.path.abspath(os.path.dirname(sys.argv[0])) + asm_file_name = os.path.realpath(asm_file_name) + asm_file_name = asm_file_name[len(cwd) + 1:] + # If it's lang.inc - skip it + if asm_file_name == 'lang.inc': + return + # If the file was handled in this execution before - skip it + if asm_file_name in handled_files: + return + # Say that the file was handled in this execution + handled_files.append(asm_file_name) + # Check if the file should be parsed + # (if it was modified or wasn't parsed yet) + should_get_declarations = True + if not it_neds_to_be_parsed(asm_file_name): + print(f"Skipping {asm_file_name} (already newest)") + should_get_declarations = False + else: + print(f"Handling {asm_file_name}") + # Remove elements parsed from this file before if any + elements_to_remove = [ + x for x in elements if x.location.split(':')[0] == asm_file_name + ] + elements = [ + x for x in elements if x.location.split(':')[0] != asm_file_name + ] + # Forget types of identifiers of names of the removed elements + for element in elements_to_remove: + if type(element) == AsmStruct: + id_remove_kind(element.name, ID_KIND_STRUCT_NAME) + elif type(element) == AsmMacro: + id_remove_kind(element.name, ID_KIND_MACRO_NAME) + # Read the source + asm_file_contents = open(asm_file_name, "r", encoding="utf-8").read() + # Find includes, fix their paths and handle em recoursively + includes = re.findall(r'^include (["\'])(.*)\1', asm_file_contents, + flags=re.MULTILINE) + for include in includes: + include = include[1].replace('\\', '/') + full_path = subdir + '/' + include + # If the path isn't valid, maybe that's not relative path + if not os.path.isfile(full_path): + full_path = include + new_subdir = full_path.rsplit('/', 1)[0] + handle_file(handled_files, full_path, new_subdir) + # Only collect declarations from the file if it wasn't parsed before + if should_get_declarations and not clean_generated_stuff: + get_declarations(asm_file_contents, asm_file_name) + +if __name__ == "__main__": + link_root = "http://websvn.kolibrios.org/filedetails.php" + link_root += "?repname=Kolibri+OS&path=/kernel/trunk" + + # Dict where an identifier is assicoated with a string + # The string contains characters specifying flags + # Available flags: + # k - Keyword + # m - Macro name + # t - fasm data Type name (db, rq, etc.) + # s - Struct type name + # e - equated constant (name equ value) + # = - set constants (name = value) + ID_KIND_KEYWORD = 'k' + ID_KIND_MACRO_NAME = 'm' + ID_KIND_FASM_TYPE = 't' + ID_KIND_STRUCT_NAME = 's' + ID_KIND_EQUATED_CONSTANT = 'e' + ID_KIND_SET_CONSTANT = '=' + id2kind = {} + + for keyword in keywords: + id_add_kind(keyword, ID_KIND_KEYWORD) + + for fasm_type in fasm_types: + id_add_kind(fasm_type, ID_KIND_FASM_TYPE) + + # Warning list + warnings = "" + + # Parameters + # Path to doxygen folder to make doxygen files in: -o + doxygen_src_path = 'docs/doxygen' + # Remove generated doxygen files: --clean + clean_generated_stuff = False + # Dump all defined symbols: --dump + dump_symbols = False + # Print symbol stats: --stats + print_stats = False + # Do not write warnings file: --nowarn + enable_warnings = True + + # Parse arguments + parser = argparse.ArgumentParser() + parser.add_argument("-o", help="Doxygen output folder") + parser.add_argument("--clean", + help="Remove generated files", + action="store_true") + parser.add_argument("--dump", + help="Dump all defined symbols", + action="store_true") + parser.add_argument("--stats", + help="Print symbol stats", + action="store_true") + parser.add_argument("--nowarn", + help="Do not write warnings file", + action="store_true") + parser.add_argument("--noemit", + help="Do not emit doxygen files (for testing)", + action="store_true") + parser.add_argument("--debug", + help="Show hashes of files (for testing)", + action="store_true") + args = parser.parse_args() + doxygen_src_path = args.o if args.o else 'docs/doxygen' + clean_generated_stuff = args.clean + dump_symbols = args.dump + print_stats = args.stats + enable_warnings = not args.nowarn + noemit = args.noemit + debug_mode = args.debug + + # Variables, functions, labels, macros, structure types + elements = [] + created_files = [] + kernel_files = [] + output_files = {} # If --debug then all the files are written here + + # Load remembered list of symbols + if os.path.isfile('asmxygen.elements.pickle'): + print('Reading existing dump of symbols') + pickle_file = open('asmxygen.elements.pickle', 'rb') + (elements, id2kind) = pickle.load(pickle_file) + pickle_file.close() + + handle_file(kernel_files, "./kernel.asm") + + if dump_symbols: + stdout = sys.stdout + sys.stdout = open('asmxygen.dump.txt', 'w', encoding='utf-8') + for asm_element in elements: + asm_element.dump() + sys.stdout = stdout + + if clean_generated_stuff: + kernel_files_set = set(kernel_files) + for file in kernel_files: + doxygen_file = f"{doxygen_src_path}/{file}" + if (os.path.isfile(doxygen_file)): + print(f"Removing {file}... ", end='') + os.remove(doxygen_file) + print("Done.") + elif not noemit: + print(f"Writing doumented sources to {doxygen_src_path}") + + i = 0 + new_elements = [x for x in elements if x.new] + for element in new_elements: + counter = f"[{i + 1}/{len(new_elements)}]" + print(f"{counter} Emitting {element.name} from {element.location}") + element.emit(doxygen_src_path) + i += 1 + + print(f"Writing dump of symbols to asmxygen.elements.pickle") + + # Now when the new elements already was written, there's no new + # elements anymore + for element in elements: + element.new = False + pickle_file = open('asmxygen.elements.pickle', 'wb') + pickle.dump((elements, id2kind), pickle_file) + pickle_file.close() + + if print_stats: + var_count = 0 + mac_count = 0 + lab_count = 0 + fun_count = 0 + uni_count = 0 + str_count = 0 + for element in elements: + if type(element) == AsmVariable: + var_count += 1 + elif type(element) == AsmMacro: + mac_count += 1 + elif type(element) == AsmLabel: + lab_count += 1 + elif type(element) == AsmFunction: + fun_count += 1 + elif type(element) == AsmUnion: + uni_count += 1 + elif type(element) == AsmStruct: + str_count += 1 + print(f'Parsed variable count: {var_count}') + print(f'Parsed macro count: {mac_count}') + print(f'Parsed label count: {lab_count}') + print(f'Parsed function count: {fun_count}') + print(f'Parsed union type count: {uni_count}') + print(f'Parsed structure type count: {str_count}') + + if enable_warnings: + open('asmxygen.txt', "w", encoding="utf-8").write(warnings) + + if debug_mode: + hash_per_file = "" + for file in output_files: + h = hashlib.sha1(bytes(output_files[file], "ascii")).hexdigest() + hash_per_file += f"{file}: {h}\n" + if not os.path.exists("asmxygen_hash_per_file.txt"): + open("asmxygen_hash_per_file.txt", "w").write(hash_per_file) + print("NEW") + else: + reference_hash_per_file = open("asmxygen_hash_per_file.txt").read() + if reference_hash_per_file != hash_per_file: + diffs = difflib.ndiff(reference_hash_per_file, hash_per_file) + print(''.join(diffs)) + else: + print("SUCCESS") diff --git a/kernel/bootloader/Tupfile.lua b/kernel/bootloader/Tupfile.lua index 087b722..be3d9d8 100644 --- a/kernel/bootloader/Tupfile.lua +++ b/kernel/bootloader/Tupfile.lua @@ -1,3 +1,3 @@ -if tup.getconfig("NO_FASM") ~= "" then return end -tup.rule("echo lang fix " .. ((tup.getconfig("LANG") == "") and "en" or tup.getconfig("LANG")) .. " > %o", {"lang.inc"}) -tup.rule({"boot_fat12.asm", extra_inputs = {"lang.inc"}}, "fasm %f %o", "boot_fat12.bin") +if tup.getconfig("NO_FASM") ~= "" then return end +tup.rule("echo lang fix " .. ((tup.getconfig("LANG") == "") and "en" or tup.getconfig("LANG")) .. " > %o", {"lang.inc"}) +tup.rule({"boot_fat12.asm", extra_inputs = {"lang.inc"}}, "fasm %f %o", "boot_fat12.bin") diff --git a/kernel/bootloader/extended_primary_loader/after_win/Tupfile.lua b/kernel/bootloader/extended_primary_loader/after_win/Tupfile.lua index 1f704df..406b399 100644 --- a/kernel/bootloader/extended_primary_loader/after_win/Tupfile.lua +++ b/kernel/bootloader/extended_primary_loader/after_win/Tupfile.lua @@ -1,2 +1,2 @@ -if tup.getconfig("NO_FASM") ~= "" then return end -tup.rule("kordldr.win.asm", "fasm %f %o", "kordldr.win.bin") +if tup.getconfig("NO_FASM") ~= "" then return end +tup.rule("kordldr.win.asm", "fasm %f %o", "kordldr.win.bin") diff --git a/kernel/bootloader/extended_primary_loader/cdfs/Tupfile.lua b/kernel/bootloader/extended_primary_loader/cdfs/Tupfile.lua index 75b9668..bf67aa1 100644 --- a/kernel/bootloader/extended_primary_loader/cdfs/Tupfile.lua +++ b/kernel/bootloader/extended_primary_loader/cdfs/Tupfile.lua @@ -1,2 +1,2 @@ -if tup.getconfig("NO_FASM") ~= "" then return end -tup.rule("bootsect.asm", "fasm %f %o ", "bootsect.bin") +if tup.getconfig("NO_FASM") ~= "" then return end +tup.rule("bootsect.asm", "fasm %f %o ", "bootsect.bin") diff --git a/kernel/bootloader/extended_primary_loader/fat1x/Tupfile.lua b/kernel/bootloader/extended_primary_loader/fat1x/Tupfile.lua index d9aa680..872aa17 100644 --- a/kernel/bootloader/extended_primary_loader/fat1x/Tupfile.lua +++ b/kernel/bootloader/extended_primary_loader/fat1x/Tupfile.lua @@ -1,3 +1,3 @@ -if tup.getconfig("NO_FASM") ~= "" then return end -tup.rule("bootsect.asm", "fasm %f %o", "bootsect.bin") -tup.rule("kordldr.f1x.asm", "fasm %f %o", "kordldr.f1x.bin") +if tup.getconfig("NO_FASM") ~= "" then return end +tup.rule("bootsect.asm", "fasm %f %o", "bootsect.bin") +tup.rule("kordldr.f1x.asm", "fasm %f %o", "kordldr.f1x.bin") diff --git a/kernel/bootloader/extended_primary_loader/fat32/Tupfile.lua b/kernel/bootloader/extended_primary_loader/fat32/Tupfile.lua index 4b40451..66b9f56 100644 --- a/kernel/bootloader/extended_primary_loader/fat32/Tupfile.lua +++ b/kernel/bootloader/extended_primary_loader/fat32/Tupfile.lua @@ -1,3 +1,3 @@ -if tup.getconfig("NO_FASM") ~= "" then return end -tup.rule("bootsect.asm", "fasm %f %o", "bootsect.bin") -tup.rule("kordldr.f32.asm", "fasm %f %o", "kordldr.f32") +if tup.getconfig("NO_FASM") ~= "" then return end +tup.rule("bootsect.asm", "fasm %f %o", "bootsect.bin") +tup.rule("kordldr.f32.asm", "fasm %f %o", "kordldr.f32") diff --git a/kernel/bootloader/uefi4kos/Tupfile.lua b/kernel/bootloader/uefi4kos/Tupfile.lua index 94cd369..7c68597 100644 --- a/kernel/bootloader/uefi4kos/Tupfile.lua +++ b/kernel/bootloader/uefi4kos/Tupfile.lua @@ -1,3 +1,3 @@ -if tup.getconfig("NO_FASM") ~= "" then return end -tup.rule({"uefi64kos.asm"}, "fasm -dUEFI=1 -dextended_primary_loader=1 %f %o", "bootx64.efi") -tup.rule({"uefi32kos.asm"}, "fasm -dUEFI=1 -dextended_primary_loader=1 %f %o", "bootia32.efi") +if tup.getconfig("NO_FASM") ~= "" then return end +tup.rule({"uefi64kos.asm"}, "fasm -dUEFI=1 -dextended_primary_loader=1 %f %o", "bootx64.efi") +tup.rule({"uefi32kos.asm"}, "fasm -dUEFI=1 -dextended_primary_loader=1 %f %o", "bootia32.efi") diff --git a/kernel/core/Tupfile.lua b/kernel/core/Tupfile.lua index ac4cfd7..5d38b96 100644 --- a/kernel/core/Tupfile.lua +++ b/kernel/core/Tupfile.lua @@ -1,3 +1,3 @@ -if tup.getconfig("NO_FASM") ~= "" then return end -tup.rule("mtrrtest.asm", "fasm %f %o", "mtrrtest.exe") -tup.rule({"test_malloc.asm", extra_inputs = {"../rev.inc"}}, "fasm %f %o", "test_malloc") +if tup.getconfig("NO_FASM") ~= "" then return end +tup.rule("mtrrtest.asm", "fasm %f %o", "mtrrtest.exe") +tup.rule({"test_malloc.asm", extra_inputs = {"../rev.inc"}}, "fasm %f %o", "test_malloc") diff --git a/kernel/docs/doxygen/doxygen.cfg b/kernel/docs/doxygen/doxygen.cfg index 8ea1e6b..ab0f05d 100644 --- a/kernel/docs/doxygen/doxygen.cfg +++ b/kernel/docs/doxygen/doxygen.cfg @@ -1,2612 +1,2612 @@ -# Doxyfile 1.9.1 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the configuration -# file that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# https://www.gnu.org/software/libiconv/ for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = "KolibriOS kernel" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all generated output in the proper direction. -# Possible values are: None, LTR, RTL and Context. -# The default value is: None. - -OUTPUT_TEXT_DIRECTION = None - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line -# such as -# /*************** -# as being the beginning of a Javadoc-style comment "banner". If set to NO, the -# Javadoc-style will behave just like regular comments and it will not be -# interpreted by doxygen. -# The default value is: NO. - -JAVADOC_BANNER = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# By default Python docstrings are displayed as preformatted text and doxygen's -# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the -# doxygen's special commands can be used and the contents of the docstring -# documentation blocks is shown as doxygen documentation. -# The default value is: YES. - -PYTHON_DOCSTRING = YES - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines (in the resulting output). You can put ^^ in the value part of an -# alias to insert a newline as if a physical newline was in the original file. -# When you need a literal { or } or , in the value part of an alias you have to -# escape them by means of a backslash (\), this can lead to conflicts with the -# commands \{ and \} for these it is advised to use the version @{ and @} or use -# a double escape (\\{ and \\}) - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice -# sources only. Doxygen will then generate output that is more tailored for that -# language. For instance, namespaces will be presented as modules, types will be -# separated into more groups, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_SLICE = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, -# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, -# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: -# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser -# tries to guess whether the code is fixed or free formatted code, this is the -# default for Fortran type files). For instance to make doxygen treat .inc files -# as Fortran files (default is PHP), and .f files as C (default is Fortran), -# use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. When specifying no_extension you should add -# * to the FILE_PATTERNS. -# -# Note see also the list of default file extension mappings. - -EXTENSION_MAPPING = inc=C asm=C - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See https://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up -# to that level are automatically included in the table of contents, even if -# they do not have an id attribute. -# Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 5. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. - -TOC_INCLUDE_HEADINGS = 5 - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use -# during processing. When set to 0 doxygen will based this on the number of -# cores available in the system. You can set it explicitly to a value larger -# than 0 to get more control over the balance between CPU load and processing -# speed. At this moment only the input processing can be done using multiple -# threads. Since this is still an experimental feature the default is set to 1, -# which efficively disables parallel processing. Please report any issues you -# encounter. Generating dot graphs in parallel is controlled by the -# DOT_NUM_THREADS setting. -# Minimum value: 0, maximum value: 32, default value: 1. - -NUM_PROC_THREADS = 1 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual -# methods of a class will be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIV_VIRTUAL = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If this flag is set to YES, the name of an unnamed parameter in a declaration -# will be determined by the corresponding definition. By default unnamed -# parameters remain unnamed in the output. -# The default value is: YES. - -RESOLVE_UNNAMED_PARAMS = YES - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# declarations. If set to NO, these declarations will be included in the -# documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# With the correct setting of option CASE_SENSE_NAMES doxygen will better be -# able to match the capabilities of the underlying filesystem. In case the -# filesystem is case sensitive (i.e. it supports files in the same directory -# whose names only differ in casing), the option must be set to YES to properly -# deal with such files in case they appear in the input. For filesystems that -# are not case sensitive the option should be be set to NO to properly deal with -# output files written for symbols that only differ in casing, such as for two -# classes, one named CLASS and the other named Class, and to also support -# references to files without having to specify the exact matching casing. On -# Windows (including Cygwin) and MacOS, users should typically set this option -# to NO, whereas on Linux or other Unix flavors it should typically be set to -# YES. -# The default value is: system dependent. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. If -# EXTRACT_ALL is set to YES then this flag will automatically be disabled. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS -# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but -# at the end of the doxygen process doxygen will return with a non-zero status. -# Possible values are: NO, YES and FAIL_ON_WARNINGS. -# The default value is: NO. - -WARN_AS_ERROR = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. - -INPUT = - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: -# https://www.gnu.org/software/libiconv/) for the list of possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# Note the list of default checked file patterns might differ from the list of -# default file extension mappings. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), -# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, -# *.ucf, *.qsf and *.ice. - -FILE_PATTERNS = *.inc *.asm - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# entity all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see https://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: -# http://clang.llvm.org/) for more accurate parsing at the cost of reduced -# performance. This can be particularly helpful with template rich C++ code for -# which doxygen's built-in parser lacks the necessary type information. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = NO - -# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to -# YES then doxygen will add the directory of each input to the include path. -# The default value is: YES. - -CLANG_ADD_INC_PATHS = YES - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -# If clang assisted parsing is enabled you can provide the clang parser with the -# path to the directory containing a file called compile_commands.json. This -# file is the compilation database (see: -# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the -# options used when the source files were built. This is equivalent to -# specifying the -p option to a clang tool, such as clang-check. These options -# will then be passed to the parser. Any options specified with CLANG_OPTIONS -# will be added as well. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. - -CLANG_DATABASE_PATH = - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# https://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - -# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML -# documentation will contain a main index with vertical navigation menus that -# are dynamically created via JavaScript. If disabled, the navigation index will -# consists of multiple levels of tabs that are statically embedded in every HTML -# page. Disable this option to support browsers that do not have JavaScript, -# like the Qt help browser. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_MENUS = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: -# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To -# create a documentation set, doxygen will generate a Makefile in the HTML -# output directory. Running make will produce the docset in that directory and -# running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy -# genXcode/_index.html for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: -# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the main .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location (absolute path -# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to -# run qhelpgenerator on the generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = YES - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = YES - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg -# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see -# https://inkscape.org) to generate formulas as SVG images instead of PNGs for -# the HTML output. These images will generally look nicer at scaled resolutions. -# Possible values are: png (the default) and svg (looks nicer but requires the -# pdf2svg or inkscape tool). -# The default value is: png. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FORMULA_FORMAT = png - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands -# to create new LaTeX commands to be used in formulas as building blocks. See -# the section "Including formulas" for details. - -FORMULA_MACROFILE = - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# https://www.mathjax.org) which uses client side JavaScript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from https://www.mathjax.org before deployment. -# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: -# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /