Showing preview only (370K chars total). Download the full file or copy to clipboard to get everything.
Repository: thufv/CMinor-Verifier
Branch: master
Commit: 3be93e5fc3f5
Files: 35
Total size: 341.4 KB
Directory structure:
gitextract_fxsz172g/
├── .github/
│ └── workflows/
│ └── build-and-test.yml
├── .gitignore
├── .gitlab-ci.yml
├── .gitmodules
├── CMinorLexer.g4
├── CMinorParser.g4
├── COPYING
├── Doxyfile
├── Program.cs
├── backend/
│ ├── BasicPath.cs
│ ├── CounterModel.cs
│ ├── SMTSolver.cs
│ ├── Verifier.cs
│ └── Z3Solver.cs
├── cminor.csproj
├── cminor.sln
├── exception/
│ ├── ParsingException.cs
│ └── ThrowingErrorListener.cs
├── frontend/
│ ├── AnnoGenerator.cs
│ ├── CFGGenerator.cs
│ ├── DeclGenerator.cs
│ ├── ExprGenerator.cs
│ ├── PredGenerator.cs
│ ├── StmtGenerator.cs
│ ├── Struct.cs
│ ├── TermGenerator.cs
│ └── Utils.cs
├── ir/
│ ├── Block.cs
│ ├── Expression.cs
│ ├── Statement.cs
│ ├── TopLevel.cs
│ ├── Type.cs
│ └── Variable.cs
├── readme.md
└── task-doc.md
================================================
FILE CONTENTS
================================================
================================================
FILE: .github/workflows/build-and-test.yml
================================================
name: Build and Test
on: [push, pull_request]
jobs:
Build-and-Test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
submodules: true
- name: Setup .NET
uses: actions/setup-dotnet@v2
with:
dotnet-version: 6.0.x
- name: Install dependencies of Python
run: pip3 install -r testcases/requirements.txt
- name: Build
run: dotnet build -c Release
- name: Test
run: python3 testcases/test.py
- name: Fetch the score
# We've saved the score into `.score` file, from which we fetch the score again.
id: score
# We follow the palette of OJ (http://codeforces.com/problemset/status)
# The badge is green if the score is full, blue otherwise.
run: |
echo "##[set-output name=data;]$(cat .score)"
echo "##[set-output name=color;]$(score=$(cat .score) && [[ $score == '100.0' ]] && echo '0A0' || echo '00A')"
- name: Score badge
uses: RubbaBoy/BYOB@v1.3.0
with:
NAME: score
LABEL: 'score'
STATUS: ${{ steps.score.outputs.data }}
COLOR: ${{ steps.score.outputs.color }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
================================================
FILE: .gitignore
================================================
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
# User-specific files
*.rsuser
*.suo
*.user
*.userosscache
*.sln.docstates
# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs
# Mono auto generated files
mono_crash.*
# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
[Ww][Ii][Nn]32/
[Aa][Rr][Mm]/
[Aa][Rr][Mm]64/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
[Ll]ogs/
# Visual Studio 2015/2017 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/
# Visual Studio 2017 auto generated files
Generated\ Files/
# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
# NUnit
*.VisualState.xml
TestResult.xml
nunit-*.xml
# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c
# Benchmark Results
BenchmarkDotNet.Artifacts/
# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/
# ASP.NET Scaffolding
ScaffoldingReadMe.txt
# StyleCop
StyleCopReport.xml
# Files built by Visual Studio
*_i.c
*_p.c
*_h.h
*.ilk
*.meta
*.obj
*.iobj
*.pch
*.pdb
*.ipdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*_wpftmp.csproj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc
# Chutzpah Test files
_Chutzpah*
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb
# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap
# Visual Studio Trace Files
*.e2e
# TFS 2012 Local Workspace
$tf/
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# AxoCover is a Code Coverage Tool
.axoCover/*
!.axoCover/settings.json
# Coverlet is a free, cross platform Code Coverage Tool
coverage*.json
coverage*.xml
coverage*.info
# Visual Studio code coverage results
*.coverage
*.coveragexml
# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*
# MightyMoose
*.mm.*
AutoTest.Net/
# Web workbench (sass)
.sass-cache/
# Installshield output folder
[Ee]xpress/
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/
# NuGet Packages
*.nupkg
# NuGet Symbol Packages
*.snupkg
# The packages folder can be ignored because of Package Restore
**/[Pp]ackages/*
# except build/, which is used as an MSBuild target.
!**/[Pp]ackages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/[Pp]ackages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets
# Microsoft Azure Build Output
csx/
*.build.csdef
# Microsoft Azure Emulator
ecf/
rcf/
# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
*.appx
*.appxbundle
*.appxupload
# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!?*.[Cc]ache/
# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs
# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
#*.snk
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/
# RIA/Silverlight projects
Generated_Code/
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
ServiceFabricBackup/
*.rptproj.bak
# SQL Server files
*.mdf
*.ldf
*.ndf
# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
*.rptproj.rsuser
*- [Bb]ackup.rdl
*- [Bb]ackup ([0-9]).rdl
*- [Bb]ackup ([0-9][0-9]).rdl
# Microsoft Fakes
FakesAssemblies/
# GhostDoc plugin setting file
*.GhostDoc.xml
# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/
# Visual Studio 6 build log
*.plg
# Visual Studio 6 workspace options file
*.opt
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw
# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions
# Paket dependency manager
.paket/paket.exe
paket-files/
# FAKE - F# Make
.fake/
# CodeRush personal settings
.cr/personal
# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc
# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config
# Tabs Studio
*.tss
# Telerik's JustMock configuration file
*.jmconfig
# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs
# OpenCover UI analysis results
OpenCover/
# Azure Stream Analytics local run output
ASALocalRun/
# MSBuild Binary and Structured Log
*.binlog
# NVidia Nsight GPU debugger configuration file
*.nvuser
# MFractors (Xamarin productivity tool) working folder
.mfractor/
# Local History for Visual Studio
.localhistory/
# BeatPulse healthcheck temp database
healthchecksdb
# Backup folder for Package Reference Convert tool in Visual Studio 2017
MigrationBackup/
# Ionide (cross platform F# VS Code tools) working folder
.ionide/
# Fody - auto-generated XML schema
FodyWeavers.xsd
# ANTLR VSCode extension temporary generated files
*.antlr/
# Pi programs for test
*.pi
# project settings for VS Code
.vscode/
Properties/
# Binary of C++
*.out
# The score of CMinor verifier
.score
================================================
FILE: .gitlab-ci.yml
================================================
image: autojudger22
cache:
key: "$CI_COMMIT_SHA"
paths:
- bin/
- testcases/
stages:
- build
- prepare_data
- test
build:
stage: build
script:
- if [ -d 'bin' ]; then rm -r bin; fi
- echo "Build starts..."
- dotnet build -c Release
- echo "Build finished."
prepare_data:
stage: prepare_data
script:
- echo "Test starts..."
- echo "Getting the latest test cases..."
- if [ -d 'testcases' ]; then rm -r testcases; fi
- git clone https://autojudger22:x7jLHuVeyDancsF46kXQ@git.tsinghua.edu.cn/software-verification-22/cminor-testcases.git
- mv cminor-testcases testcases
- ls testcases
- echo "Latest test cases got."
test:
stage: test
script:
- echo "Running the tests..."
- ls testcases
- python3.8 testcases/test.py
- echo "Test finished."
================================================
FILE: .gitmodules
================================================
[submodule "testcases"]
path = testcases
url = git@github.com:thufv/CMinor-testcases.git
branch = master
================================================
FILE: CMinorLexer.g4
================================================
/*
* This lexer grammar only targets C#.
*/
lexer grammar CMinorLexer;
@header {#pragma warning disable 3021}
@preinclude {
using Antlr4.Runtime;
}
@members {
bool inAnnot = false;
bool inLineAnnot = false;
}
/* --- literals --- */
VOID: 'void';
STRUCT: 'struct';
LPAR: '(';
RPAR: ')';
LBRACE: '{';
RBRACE: '}';
COMMA: ',';
SEMICOLON: ';';
LBRACKET: '[';
RBRACKET: ']';
PERIOD: '.';
INT: 'int';
FLOAT: 'float';
BOOL: 'bool';
IF: 'if';
ELSE: 'else';
BREAK: 'break';
CONTINUE: 'continue';
RETURN: 'return';
WHILE: 'while';
DO: 'do';
FOR: 'for';
ASSIGN: '=';
EQ: '==';
NE: '!=';
LE: '<=';
LT: '<';
GE: '>=';
GT: '>';
ADD: '+';
MINUS: '-';
MUL: '*';
DIV: '/';
NEG: '!';
MOD: '%';
AND: '&&';
OR: '||';
EXPR_TRUE: 'true';
EXPR_FALSE: 'false';
ANNO_TRUE: '\\true';
ANNO_FALSE: '\\false';
RESULT: '\\result';
LENGTH: '\\length';
OLD: '\\old';
WITH: '\\with';
IMPLY: '==>';
EQUIV: '<==>';
XOR: '^^';
FORALL: '\\forall';
EXISTS: '\\exists';
BOOLEAN: 'boolean';
INTEGER: 'integer';
REAL: 'real';
REQUIRES: 'requires';
DECREASES: 'decreases';
ENSURES: 'ensures';
ASSERT: 'assert';
LOOP: 'loop';
INVARIANT: 'invariant';
VARIANT: 'variant';
PREDICATE: 'predicate';
VALID: '\\valid';
APOSTROPHE: '..';
/* --- constants --- */
INT_CONSTANT: [0-9]+;
FLOAT_CONSTANT: [0-9]+ '.' [0-9]+;
IDENT: [a-zA-Z] [a-zA-Z0-9_]*;
/* --- comments --- */
COMMENT: '/*' ('*/' | ~('@') .*? '*/') -> skip;
LINE_COMMENT: '//' ([\r\n] | ~('@') ~[\r\n]*) -> skip;
/* --- annotationss --- */
ANNOT_START: '/*@' { inAnnot = true; };
ANNOT_END: '*/' { inAnnot = false; };
LINE_ANNOT_START: '//@' { inLineAnnot = true; };
/* --- '@' is skipped in annotation --- */
AT: '@' { if (inAnnot || inLineAnnot) Skip(); };
/* --- LINEEND cannot be skipped for line annotation --- */
LINEEND: [\r\n] {
if (inLineAnnot) inLineAnnot = false;
else Skip();
};
/* --- skip white spaces --- */
WS: [ \t\u000C] -> skip;
================================================
FILE: CMinorParser.g4
================================================
/*
* compatible with ACSL language grammar v1.17
*/
parser grammar CMinorParser;
options {
tokenVocab = CMinorLexer;
}
@header {#pragma warning disable 3021}
/* top level */
main: def* EOF;
def: funcDef | structDef | predDefs;
funcDef:
funcContract retVar '(' (paraVar (',' paraVar)*)? ')' '{' (
decl
| stmt
)* '}';
structDef: 'struct' IDENT '{' (atomicType IDENT ';')* '}' ';';
/* variable */
localVar:
atomicType IDENT
| 'struct' IDENT IDENT
| atomicType IDENT '[' INT_CONSTANT ']';
paraVar:
atomicType IDENT
| 'struct' IDENT IDENT
| atomicType IDENT '[' ']';
retVar:
atomicType IDENT
| 'struct' IDENT IDENT
| 'void' IDENT;
atomicType: 'int' | 'float';
logicParaVar:
logicAtomicType IDENT
| 'struct' IDENT IDENT
| logicAtomicType '[' ']' IDENT;
logicAtomicType: 'integer' | 'real' | 'boolean';
/* about statement */
stmt:
';' # EmptyStmt
| expr ';' # ExprStmt
| assign ';' # AssignStmt
| 'if' '(' expr ')' stmt ('else' stmt)? # IfStmt
| loopAnnot 'while' '(' expr ')' stmt # WhileStmt
| loopAnnot 'do' stmt 'while' '(' expr ')' # DoStmt
| loopAnnot 'for' '(' forInit? ';' expr? ';' forIter? ')' stmt # ForStmt
| 'break' ';' # BreakStmt
| 'continue' ';' # ContStmt
| 'return' expr? ';' # ReturnStmt
| assertion # AssertStmt
| '{' (stmt | decl)* '}' # BlockStmt;
forInit: localVar ('=' expr)? | assign;
forIter: assign | expr;
assign:
IDENT '=' expr # VarAssign
| IDENT '[' expr ']' '=' expr # SubAssign
| IDENT '.' IDENT '=' expr # MemAssign;
decl: localVar ('=' expr)? ';';
/* about expression */
expr:
IDENT # IdentExpr
| constant # ConstExpr
| IDENT '(' (expr (',' expr)*)? ')' # CallExpr
| '(' expr ')' # ParExpr
| expr '[' expr ']' # ArrAccessExpr
| expr '.' IDENT # MemExpr
| ('!' | '-') expr # UnaryExpr
| expr ('*' | '/' | '%') expr # MulExpr
| expr ('+' | '-') expr # AddExpr
| expr ('<' | '<=' | '>' | '>=') expr # OrdExpr
| expr ('==' | '!=') expr # EquExpr
| expr '&&' expr # AndExpr
| expr '||' expr # OrExpr;
/* annotation */
logicConstant:
INT_CONSTANT
| FLOAT_CONSTANT
| '\\true'
| '\\false';
arithTerm:
IDENT # IdentTerm
| '\\result' # ResTerm
| logicConstant # ConstTerm
| '{' arithTerm '\\with' '[' arithTerm ']' '=' arithTerm '}' # ArrUpdTerm
| '(' arithTerm ')' # ParArithTerm
| arithTerm '[' arithTerm ']' # ArrAccessTerm
| arithTerm '.' IDENT # MemTerm
| ('-' | '!') arithTerm # UnaryTerm
| arithTerm ('*' | '/' | '%') arithTerm # MulTerm
| arithTerm ('+' | '-') arithTerm # AddTerm;
term:
arithTerm # AriTerm
| '(' term ')' # ParTerm
| term ('<' | '<=' | '>' | '>=') term # OrdTerm
| term ('==' | '!=') term # EquTerm
| term '&&' term # AndTerm
| term '||' term # OrTerm;
pred:
'\\true' # TruePred
| '\\false' # FalsePred
| arithTerm (
('<' | '<=' | '>' | '>=' | '==' | '!=') arithTerm
)+ # CmpPred
| IDENT ('(' term (',' term)* ')')? # CallPred
| '(' pred ')' # ParPred
| pred '&&' pred # ConPred
| pred '||' pred # DisPred
| pred '==>' pred # ImpPred
| pred '<==>' pred # IffPred
| '!' pred # NegPred
| pred '^^' pred # XorPred
// 这里化简了 ACSL 中 location 和 tset 的概念 range 是个闭区间，其首尾的类型都只能是 integer
| '\\valid' '(' IDENT '+' '(' INT_CONSTANT '..' arithTerm ')' ')' # LengthPred
| ('\\forall' | '\\exists') binder (',' binder)* ';' pred # QuantiPred;
binder: logicAtomicType IDENT (',' IDENT)*;
funcContract:
'/*@' requiresClause* decreasesClause? ensuresClause* '*/'
| '//@' requiresClause* decreasesClause? ensuresClause* LINEEND;
requiresClause: 'requires' pred ';';
decreasesClause:
'decreases' (arithTerm | '(' arithTerm (',' arithTerm)+ ')') ';';
ensuresClause: 'ensures' pred ';';
assertion:
'/*@' 'assert' pred ';' '*/'
| '//@' 'assert' pred ';' LINEEND;
loopAnnot:
'/*@' ('loop' 'invariant' pred ';')* (
'loop' 'variant' (arithTerm | '(' arithTerm (',' arithTerm)+ ')') ';'
)? '*/'
| '//@' ('loop' 'invariant' pred ';')* (
'loop' 'variant' (arithTerm | '(' arithTerm (',' arithTerm)+ ')') ';'
)? LINEEND;
predDefs:
'/*@' predDef* '*/'
| '//@' predDef* LINEEND;
predDef:
'predicate' IDENT (
'(' logicParaVar (',' logicParaVar)* ')'
)? '=' pred ';';
/* miscellaneous */
constant: INT_CONSTANT | FLOAT_CONSTANT | 'true' | 'false';
================================================
FILE: COPYING
================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.
================================================
FILE: Doxyfile
================================================
# Doxyfile 1.9.3
# 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 = "CMinor"
# 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 = Chinese
# 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:^^"
# 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:". Note that you cannot 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++, Lex, 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 =
# 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 effectively 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_HEADERFILE tag is set to YES then the documentation for a class
# will show which file needs to be included to use the class.
# The default value is: YES.
SHOW_HEADERFILE = YES
# 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 <section_label> ... \endif and \cond <section_label>
# ... \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. See also section "Changing the
# layout of pages" for information.
#
# 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 documenting some parameters in
# a documented function twice, or documenting parameters that don't exist or
# using markup commands wrongly.
# The default value is: YES.
WARN_IF_DOC_ERROR = YES
# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
# function parameter documentation. If set to NO, doxygen will accept that some
# parameters have no documentation without warning.
# The default value is: YES.
WARN_IF_INCOMPLETE_DOC = 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 parameter
# documentation, but not about the absence of documentation. If EXTRACT_ALL is
# set to YES then this flag will automatically be disabled. See also
# WARN_IF_INCOMPLETE_DOC
# 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). In case the file specified cannot be opened for writing the
# warning and error messages are written to standard error. When as file - is
# specified the warning and error messages are written to standard output
# (stdout).
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 = Program.cs backend/ ir/ frontend/ exception/
# 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++, *.l, *.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 = *.cs
# 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,
# ANamespace::AClass, 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:
#
# <filter> <input-file>
#
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> 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 the CLANG_ASSISTED_PARSING tag is set to YES 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.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to 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 = api-doc
# 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 color-wheel, 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 gray-scales 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 determines the URL 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.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDURL =
# 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
# on Windows. In the beginning of 2021 Microsoft took the original page, with
# a.o. the download links, offline the HTML help workshop was already many years
# in maintenance mode). You can download the HTML help workshop from the web
# archives at Installation executable (see:
# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
#
# 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 = NO
# 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 (see "Fine-tuning the output"). 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 = NO
# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
# area (value NO) or if it should extend to the full height of the window (value
# YES). Setting this to YES gives a layout similar to
# https://docs.readthedocs.io with more room for contents, but less room for the
# project logo, title, and description. If either GENERATE_TREEVIEW or
# DISABLE_INDEX is set to NO, this option has no effect.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
FULL_SIDEBAR = NO
# 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 OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
# addresses.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
OBFUSCATE_EMAILS = YES
# 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
# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
# Note that the different versions of MathJax have different requirements with
# regards to the different settings, so it is possible that also other MathJax
# settings have to be changed when switching between the different MathJax
# versions.
# Possible values are: MathJax_2 and MathJax_3.
# The default value is: MathJax_2.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_VERSION = MathJax_2
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. For more details about the output format see MathJax
# version 2 (see:
# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
# (see:
# http://docs.mathjax.org/en/latest/web/components/output.html).
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility. This is the name for Mathjax version 2, for MathJax version 3
# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
# is the name for Mathjax version 3, for MathJax version 2 this will be
# translated into HTML-CSS) 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:
# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH =
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
# for MathJax version 2 (see
# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# For example for MathJax version 3 (see
# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
# MATHJAX_EXTENSIONS = ams
# 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 <access key> + S
# (what the <access key> is depends on the OS and browser, but it is typically
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
# key> to jump into the search results window, the results can be navigated
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
# the search. The filter options can be selected when the cursor is inside the
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
# to select a filter and <Enter> or <escape> to activate or cancel the filter
# option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = YES
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using JavaScript. There
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
# setting. When disabled, doxygen will generate a PHP script for searching and
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
# and searching needs to be provided by external tools. See the section
# "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file
# which needs to be processed by an external indexer. Doxygen will invoke an
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
# search results.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see:
# https://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH = NO
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will return the search results when EXTERNAL_SEARCH is enabled.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see:
# https://xapian.org/). See the section "External Indexing and Searching" for
# details.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHENGINE_URL =
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the
# SEARCHDATA_FILE tag the name of this file can be specified.
# The default file is: searchdata.xml.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHDATA_FILE = searchdata.xml
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
# projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH_ID =
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
# projects other than the one defined by this configuration file, but that are
# all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
# to a relative location where the documentation can be found. The format is:
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX 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: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked.
#
# Note that when not enabling USE_PDFLATEX the default is latex when enabling
# USE_PDFLATEX the default is pdflatex and when in the later case latex is
# chosen this is overwritten by pdflatex. For specific output languages the
# default can have been set differently, this depends on the implementation of
# the output language.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME =
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# index for LaTeX.
# Note: This tag is used in the Makefile / make.bat.
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
# (.tex).
# The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = makeindex
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
# generate index for LaTeX. In case there is no backslash (\) as first character
# it will be automatically added in the LaTeX code.
# Note: This tag is used in the generated output file (.tex).
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
# The default value is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_MAKEINDEX_CMD = makeindex
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used by the
# printer.
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
# 14 inches) and executive (7.25 x 10.5 inches).
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. The package can be specified just
# by its name or with the correct syntax as to be used with the LaTeX
# \usepackage command. To get the times font for instance you can specify :
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
# To use the option intlimits with the amsmath package you can specify:
# EXTRA_PACKAGES=[intlimits]{amsmath}
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
# the generated LaTeX document. The header should contain everything until the
# first chapter. If it is left blank doxygen will generate a standard header. It
# is highly recommended to start with a default header using
# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
# and then modify the file new_header.tex. See also section "Doxygen usage" for
# information on how to generate the default header that doxygen normally uses.
#
# Note: Only use a user-defined header if you know what you are doing!
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. The following
# commands have a special meaning inside the header (and footer): For a
# description of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER =
# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
# the generated LaTeX document. The footer should contain everything after the
# last chapter. If it is left blank doxygen will generate a standard footer. See
# LATEX_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. Note: Only use a user-defined footer if you know what you are
# doing!
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER =
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# LaTeX style sheets that are included after the standard style sheets created
# by doxygen. Using this option one can overrule certain style aspects. 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).
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_STYLESHEET =
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the LATEX_OUTPUT output
# directory. Note that the files will be copied as-is; there are no commands or
# markers available.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_FILES =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
# contain links (just like the HTML output) instead of page references. This
# makes the output suitable for online browsing using a PDF viewer.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
# files. Set this option to YES, to get a higher quality PDF documentation.
#
# See also section LATEX_CMD_NAME for selecting the engine.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
# command to the generated LaTeX files. This will instruct LaTeX to keep running
# if errors occur, instead of asking the user for help.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BATCHMODE = NO
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
# index chapters (such as File Index, Compound Index, etc.) in the output.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HIDE_INDICES = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
# The default value is: plain.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
# page will contain the date and time when the page was generated. Setting this
# to NO can help when comparing the output of multiple runs.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_TIMESTAMP = NO
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
# path from which the emoji images will be read. If a relative path is entered,
# it will be relative to the LATEX_OUTPUT directory. If left blank the
# LATEX_OUTPUT directory will be used.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EMOJI_DIRECTORY =
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
# readers/editors.
# The default value is: NO.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF 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: rtf.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
# contain hyperlink fields. The RTF file will contain links (just like the HTML
# output) instead of page references. This makes the output suitable for online
# browsing using Word or some other Word compatible readers that support those
# fields.
#
# Note: WordPad (write) and others do not support links.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# configuration file, i.e. a series of assignments. You only have to provide
# replacements, missing definitions are set to their default value.
#
# See also section "Doxygen usage" for information on how to generate the
# default style sheet that doxygen normally uses.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an RTF document. Syntax is
# similar to doxygen's configuration file. A template extensions file can be
# generated using doxygen -e rtf extensionFile.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
# classes and files.
# The default value is: NO.
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it. A directory man3 will be created inside the directory specified by
# MAN_OUTPUT.
# The default directory is: man.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to the generated
# man pages. In case the manual section does not start with a number, the number
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
# optional.
# The default value is: .3.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .3
# The MAN_SUBDIR tag determines the name of the directory created within
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
# MAN_EXTENSION with the initial . removed.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_SUBDIR =
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
# will generate one additional man file for each entity documented in the real
# man page(s). These additional files only source the real man page, but without
# them the man command would be unable to find the correct page.
# The default value is: NO.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
# captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages 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: xml.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_OUTPUT = xml
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
# the XML output. Note that enabling this will significantly increase the size
# of the XML output.
# The default value is: YES.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_PROGRAMLISTING = YES
# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
# namespace members in file scope as well, matching the HTML output.
# The default value is: NO.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_NS_MEMB_FILE_SCOPE = NO
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
# that can be used to generate PDF.
# The default value is: NO.
GENERATE_DOCBOOK = NO
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages 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: docbook.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_OUTPUT = docbook
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
# the structure of the code including all documentation. Note that this feature
# is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
# file that captures the structure of the code including all documentation.
#
# Note that this feature is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
# output from the Perl module output.
# The default value is: NO.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
# formatted so it can be parsed by a human reader. This is useful if you want to
# understand what is going on. On the other hand, if this tag is set to NO, the
# size of the Perl module output will be much smaller and Perl will parse it
# just the same.
# The default value is: YES.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file are
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
# so different doxyrules.make files included by the same Makefile don't
# overwrite each other's variables.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
# C-preprocessor directives found in the sources and include files.
# The default value is: YES.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
# in the source code. If set to NO, only conditional compilation will be
# performed. Macro expansion can be done in a controlled way by setting
# EXPAND_ONLY_PREDEF to YES.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = NO
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and
# EXPAND_AS_DEFINED tags.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
# INCLUDE_PATH will be searched if a #include is found.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by the
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
# used.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that are
# defined before the preprocessor is started (similar to the -D option of e.g.
# gcc). The argument of the tag is a list of macros of the form: name or
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
# is assumed. To prevent a macro definition from being undefined via #undef or
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED =
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
# macro definition that is found in the sources will be used. Use the PREDEFINED
# tag if you want to use a different macro definition that overrules the
# definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all references to function-like macros that are alone on a line, have
# an all uppercase name, and do not end with a semicolon. Such function macros
# are typically used for boiler-plate code, and will confuse the parser if not
# removed.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
# The TAGFILES tag can be used to specify one or more tag files. For each tag
# file the location of the external documentation should be added. The format of
# a tag file without this location is as follows:
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
# section "Linking to external documentation" for more information about the use
# of tag files.
# Note: Each tag file must have a unique name (where the name does NOT include
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
# the class index. If set to NO, only the inherited external classes will be
# listed.
# The default value is: NO.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will be
# listed.
# The default value is: YES.
EXTERNAL_GROUPS = YES
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
# the related pages index. If set to NO, only the current project's pages will
# be listed.
# The default value is: YES.
EXTERNAL_PAGES = YES
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
# If left empty dia is assumed to be found in the default search path.
DIA_PATH =
# If set to YES the inheritance and collaboration graphs will hide inheritance
# and usage relations if the target is undocumented or is not a class.
# The default value is: YES.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz (see:
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: NO.
HAVE_DOT = NO
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
# processors available in the system. You can set it explicitly to a value
# larger than 0 to get control over the balance between CPU load and processing
# speed.
# Minimum value: 0, maximum value: 32, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NUM_THREADS = 0
# When you want a differently looking font in the dot files that doxygen
# generates you can specify the font name using DOT_FONTNAME. You need to make
# sure dot is able to find the font, which can be done by putting it in a
# standard location or by setting the DOTFONTPATH environment variable or by
# setting DOT_FONTPATH to the directory containing the font.
# The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTNAME = Helvetica
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# dot graphs.
# Minimum value: 4, maximum value: 24, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the default font as specified with
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
# the path where dot can find it using this tag.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTPATH =
# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
# graph for each documented class showing the direct and indirect inheritance
# relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
# to TEXT the direct and indirect inheritance relations will be shown as texts /
# links.
# Possible values are: NO, YES, TEXT and GRAPH.
# The default value is: YES.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
# graph for each documented class showing the direct and indirect implementation
# dependencies (inheritance, containment, and class references variables) of the
# class with other documented classes.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
COLLABORATION_GRAPH = YES
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
# groups, showing the direct groups dependencies.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LOOK = NO
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
# class node. If there are many fields or methods and many nodes the graph may
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
# number of items for each type to make the size more manageable. Set this to 0
# for no limit. Note that the threshold may be exceeded by 50% before the limit
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
# but if the number exceeds 15, the total amount of fields shown is limited to
# 10.
# Minimum value: 0, maximum value: 100, default value: 10.
# This tag requires that the tag UML_LOOK is set to YES.
UML_LIMIT_NUM_FIELDS = 10
# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
# tag is set to YES, doxygen will add type and arguments for attributes and
# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
# will not generate fields with class member information in the UML graphs. The
# class diagrams will look similar to the default class diagrams but using UML
# notation for the relationships.
# Possible values are: NO, YES and NONE.
# The default value is: NO.
# This tag requires that the tag UML_LOOK is set to YES.
DOT_UML_DETAILS = NO
# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
# to display on a single line. If the actual line length exceeds this threshold
# significantly it will wrapped across multiple lines. Some heuristics are apply
# to avoid ugly line breaks.
# Minimum value: 0, maximum value: 1000, default value: 17.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_WRAP_THRESHOLD = 17
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
# collaboration graphs will show the relations between templates and their
# instances.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
TEMPLATE_RELATIONS = NO
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
# YES then doxygen will generate a graph for each documented file showing the
# direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDE_GRAPH = YES
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
# set to YES then doxygen will generate a graph for each documented file showing
# the direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command. Disabling a call graph can be
# accomplished by means of the command \hidecallgraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALL_GRAPH = NO
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable caller graphs for selected
# functions only using the \callergraph command. Disabling a caller graph can be
# accomplished by means of the command \hidecallergraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
# hierarchy of all classes instead of a textual one.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
# dependencies a directory has on other directories in a graphical way. The
# dependency relations are determined by the #include relations between the
# files in the directories.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DIRECTORY_GRAPH = YES
# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
# of child directories generated in directory dependency graphs by dot.
# Minimum value: 1, maximum value: 25, default value: 1.
# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
DIR_GRAPH_MAX_DEPTH = 1
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. For an explanation of the image formats see the section
# output formats in the documentation of the dot tool (Graphviz (see:
# http://www.graphviz.org/)).
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
# png:gdiplus:gdiplus.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = png
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
#
# Note that this requires a modern browser other than Internet Explorer. Tested
# and working are Firefox, Chrome, Safari, and Opera.
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
# the SVG files visible. Older versions of IE do not have SVG support.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO
# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the \dotfile
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
# The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the \mscfile
# command).
MSCFILE_DIRS =
# The DIAFILE_DIRS tag can be used to specify one or more directories that
# contain dia files that are included in the documentation (see the \diafile
# command).
DIAFILE_DIRS =
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
# path where java can find the plantuml.jar file or to the filename of jar file
# to be used. If left blank, it is assumed PlantUML is not used or called during
# a preprocessing step. Doxygen will generate a warning when it encounters a
# \startuml command in this case and will not generate output for the diagram.
PLANTUML_JAR_PATH =
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
# configuration file for plantuml.
PLANTUML_CFG_FILE =
# When using plantuml, the specified paths are searched for files specified by
# the !include statement in a plantuml block.
PLANTUML_INCLUDE_PATH =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
# that will be shown in the graph. If the number of nodes in a graph becomes
# larger than this value, doxygen will truncate the graph, which is visualized
# by representing a node as a red box. Note that doxygen if the number of direct
# children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
# root by following a path via at most 3 edges will be shown. Nodes that lay
# further from the root node will be omitted. Note that setting this option to 1
# or 2 may greatly reduce the computation time needed for large code bases. Also
# note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not seem
# to support this out of the box.
#
# Warning: Depending on the platform used, enabling this option may lead to
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
# read).
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
# this, this feature is disabled by default.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
# explaining the meaning of the various boxes and arrows in the dot generated
# graphs.
# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
# graphical representation for inheritance and collaboration diagrams is used.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
# files that are used to generate the various graphs.
#
# Note: This setting is not only used for dot files but also for msc temporary
# files.
# The default value is: YES.
DOT_CLEANUP = YES
================================================
FILE: Program.cs
================================================
/* Copyright 2022 Xingyu Xie
This file is part of CMinor.
CMinor is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
CMinor is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with CMinor. If not, see <https://www.gnu.org/licenses/>. */
using System;
using System.IO;
using System.Collections.Generic;
using Antlr4.Runtime;
using Antlr4.Runtime.Misc;
using CommandLine;
using CommandLine.Text;
namespace cminor
{
/// <summary> 整个验证工具的入口类 </summary>
class Program
{
class Options
{
[Option("source",
Required = true,
HelpText = "The source file of CMinor language (recommended with filename extension '.c').")]
public string sourcePath { get; set; } = default!;
[Option("printCFG",
Required = false,
HelpText = "The file (or 'console') to which the control flow graph is printed.")]
public string? CFGFile { get; set; } = null;
[Usage(ApplicationAlias = "cminor")]
public static IEnumerable<Example> Examples
{
get
{
return new List<Example>()
{
new Example("The simplest usage to compile and verify a pi source file", new Options
{
sourcePath = "<path>"
})
};
}
}
}
/// <summary> 整个验证工具的入口函数 </summary>
static void Main(string[] args)
{
CommandLine.Parser.Default.ParseArguments<Options>(args)
.WithParsed(RunOptions);
}
/// <summary> 整个验证工具的主驱动函数 </summary>
/// <remarks>
/// 返回码的设计是这样的：
/// <list type="bullet">
/// <item> 0 表示验证成功 </item>
/// <item> 1 表示验证失败 </item>
/// <item> 2 表示语义错误 </item>
/// <item> 3 表示语法错误 </item>
/// </list>
/// </remarks>
static void RunOptions(Options opts)
{
try
{
// 首先，我们要生成 cfg！
StreamReader reader = File.OpenText(opts.sourcePath);
AntlrInputStream stream = new AntlrInputStream(reader);
ITokenSource lexer = new CMinorLexer(stream);
ITokenStream tokens = new CommonTokenStream(lexer);
CMinorParser parser = new CMinorParser(tokens);
// 由于现有的 error listener 或者 handler，
// 要么不会终止 parse，要么连行号都不会打印出来……
// 所以我们需要写一个新的 listener！
parser.RemoveErrorListeners();
parser.AddErrorListener(new ThrowingErrorListener());
CMinorParser.MainContext tree = parser.main();
CFGGenerator generator = new CFGGenerator();
IRMain cfg = generator.Apply(tree);
if (opts.CFGFile != null)
{
// 输出 cfg
using (TextWriter writer = opts.CFGFile == "console"
? Console.Out
: new StreamWriter(opts.CFGFile))
{
cfg.Print(writer);
}
}
Verifier verifier = new Verifier(Console.Out);
int result = verifier.Apply(cfg);
if (result > 0) Console.WriteLine("VERIFIED");
else if (result == 0) Console.WriteLine("UNKNOWN");
else if (result < 0) Console.WriteLine("UNVERIFIED");
Environment.Exit(0);
}
catch (ParsingException e)
{
Console.Error.WriteLine($"semantic error: {e.Message}");
Environment.Exit(1);
}
catch (ParseCanceledException e)
{
Console.Error.WriteLine($"syntax error: {e.Message}");
Environment.Exit(1);
}
}
}
}
================================================
FILE: backend/BasicPath.cs
================================================
/* Copyright 2022 Xingyu Xie
This file is part of CMinor.
CMinor is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
CMinor is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with CMinor. If not, see <https://www.gnu.org/licenses/>. */
using System.Diagnostics.Contracts;
using System.Collections.Generic;
namespace cminor
{
class BasicPath
{
public List<Expression> headConditions = new List<Expression>();
public List<Expression> headRankingFunctions = new List<Expression>();
// only assumement, assignment are allowed
public List<Statement> statements = new List<Statement>();
public List<Expression> tailConditions = new List<Expression>();
public List<Expression> tailRankingFunctions = new List<Expression>();
[ContractInvariantMethod]
void ObjectInvariant()
{
foreach (Expression headCondition in headConditions)
Contract.Invariant(headCondition.type is BoolType);
}
}
}
================================================
FILE: backend/CounterModel.cs
================================================
/* Copyright 2022 Xingyu Xie
This file is part of CMinor.
CMinor is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
CMinor is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with CMinor. If not, see <https://www.gnu.org/licenses/>. */
using System.IO;
using System.Collections.Generic;
namespace cminor
{
class CounterModel
{
// 一个比较悲哀的事实是，由于 SMT solver 对 array 的处理方式是将其看做是一个特殊的
// uninterpreted function，所以在其 model 中可能会是一个比较复杂的表达式。
// 因此，这里我们没有办法比较好地处理 assign，只能将其都转为字符串。作为一个只是能打印
// 出来（或许对同学们来说还是非常难以理解的……）的字符串。
Dictionary<string, string> assignments = default!;
public CounterModel(Dictionary<string, string> assignments)
{
this.assignments = assignments;
}
/// <summary> 将这个反例模型打印出来。 </summary>
/// <remarks> 打印的头尾信息是尽量和 Boogie 保持一致的。 </remarks>
public void Print(TextWriter writer)
{
writer.WriteLine("*** COUNTER MODEL");
foreach ((string name, string assignment) in assignments)
{
writer.WriteLine($"{name} = {assignment}");
}
writer.WriteLine("*** END COUNTER MODEL");
}
}
}
================================================
FILE: backend/SMTSolver.cs
================================================
/* Copyright 2022 Xingyu Xie
This file is part of CMinor.
CMinor is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
CMinor is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with CMinor. If not, see <https://www.gnu.org/licenses/>. */
using System.Collections.Generic;
namespace cminor
{
/// <summary> 对真正的 SMT Solver 的一层封装 </summary>
/// <remarks>
/// 不过我们目前还只支持 z3。。。
/// 之后会考虑支持 cvc5，以及把这一层封装也换成更成熟的封装。
/// </remarks>
class SMTSolver
{
Dictionary<string, Expression> predicates = new Dictionary<string, Expression>();
Z3Solver z3Solver = new Z3Solver();
/// <summary> 检查逻辑表达式的有效性 </summary>
/// <param name="expression"> 待检查的逻辑表达式 </param>
/// <returns> 为 null 的话就表示 valid，否则返回一个反例模型。 </returns>
public CounterModel? CheckValid(Expression expression)
{
return z3Solver.CheckValid(expression);
}
/// <summary> 在 SMT solver 中定义谓词 </summary>
/// <param name="predicate"> 待定义的谓词 </param>
/// <remarks> 目前我们只允许一个表达式作为谓词，而且谓词不允许递归调用。 </remarks>
public void definePredicate(Predicate predicate)
{
z3Solver.definePredicate(predicate);
}
}
}
================================================
FILE: backend/Verifier.cs
================================================
/* Copyright 2022 Xingyu Xie
This file is part of CMinor.
CMinor is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
CMinor is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with CMinor. If not, see <https://www.gnu.org/licenses/>. */
/*
TODO: 这是你唯一允许编辑的文件，你可以对此文件作任意的修改，只要整个项目可以正常地跑起来。
*/
using System;
using System.IO;
using System.Linq;
using System.Collections.Generic;
using System.IO;
namespace cminor
{
/// <summary> 一个验证器，接受一个中间表示，判断其是否有效。 </summary>
class Verifier
{
SMTSolver solver = new SMTSolver();
TextWriter writer;
public Verifier(TextWriter writer)
{
this.writer = writer;
}
/// <summary> 应用此验证器 </summary>
/// <param name="cfg"> 待验证的控制流图 </param>
/// <returns> 验证结果 </returns>
/// <list type="bullet">
/// <item> “> 0” 表示所有的 specification 都成立 </item>
/// <item> “< 0” 表示有一个 specification 不成立 </item>
/// <item> “= 0” 表示 unknown </item>
/// </list>
public int Apply(IRMain cfg)
{
return 0;
}
}
}
================================================
FILE: backend/Z3Solver.cs
================================================
/* Copyright 2022 Xingyu Xie, Jiangyi Liu
This file is part of CMinor.
CMinor is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
CMinor is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with CMinor. If not, see <https://www.gnu.org/licenses/>. */
using System;
using System.Linq;
using System.Diagnostics;
using System.Collections.Generic;
using Microsoft.Z3;
namespace cminor
{
/// <summary> 对 Z3 求解器的一层封装 </summary>
class Z3Solver
{
Context ctx = new Context(new Dictionary<string, string>() {
{ "model", "true" }
});
public Z3Solver()
{
Microsoft.Z3.Global.SetParameter("parallel.enable", "false");
}
/// <summary> 对逻辑表达式的有效性的检查。 </summary>
/// <param name="expression"> 待检查有效性的逻辑表达式 </param>
/// <returns> 如果表达式有效，那么就返回 null；否则的话，返回一个反例模型。</returns>
public CounterModel? CheckValid(Expression expression)
{
Solver solver = ctx.MkSolver();
Expr expr = ExpressionToZ3Expr(expression).Simplify();
Debug.Assert(expr is BoolExpr);
// Z3 默认求解的是 satisfiable
// 为了判断 valid，我们需要先取反
solver.Assert(ctx.MkNot((BoolExpr)expr));
Status status = solver.Check();
if (status == Status.UNSATISFIABLE)
{
return null;
}
else
{
Dictionary<string, string> assignments = new Dictionary<string, string>();
foreach ((FuncDecl decl, Expr valueExpr) in solver.Model.Consts)
{
assignments.Add(decl.Name.ToString(), valueExpr.ToString());
}
return new CounterModel(assignments);
}
}
/// <summary> 把我们的 IR 里的表达式转成 Z3 里的表达式 </summary>
/// <remarks> 注意我们的 constant 其实需要对应到 z3 里的 numeral，我们的 variable 需要对应到 z3 里的 const。</remarks>
Expr ExpressionToZ3Expr(Expression e)
{
switch (e)
{
case VariableExpression ve:
{
string name = ve.variable.name;
switch (ve.variable.type)
{
case IntType:
return ctx.MkIntConst(name);
case FloatType:
return ctx.MkRealConst(name);
case BoolType:
return ctx.MkBoolConst(name);
case ArrayType at:
switch (at.atomicType)
{
case IntType:
return ctx.MkArrayConst(name, ctx.IntSort, ctx.IntSort);
case FloatType:
return ctx.MkArrayConst(name, ctx.IntSort, ctx.RealSort);
case BoolType:
return ctx.MkArrayConst(name, ctx.IntSort, ctx.BoolSort);
default:
throw new ArgumentException("there's an atomic type that is neither 'int', 'float' or 'bool'. Probably a bug occurs.");
}
}
break;
}
case IntConstantExpression ice:
return ctx.MkNumeral(ice.constant, ctx.IntSort);
case FloatConstantExpression fce:
return ctx.MkReal(fce.constant.ToString());
case BoolConstantExpression bce:
return ctx.MkBool(bce.constant);
case PredicateCallExpression pce:
// 里面的 predicate 应该是已经被预先声明好了
Debug.Assert(predicates.ContainsKey(pce.predicate));
return predicates[pce.predicate].Item1.Substitute(
from: predicates[pce.predicate].Item2,
to: pce.argumentExpressions.Select(
expression => ExpressionToZ3Expr(expression)).ToArray());
case ArrayAccessExpression aae:
{
Expr array = ExpressionToZ3Expr(aae.array);
Expr subscript = ExpressionToZ3Expr(aae.subscript);
Debug.Assert(array is ArrayExpr);
return ctx.MkSelect((ArrayExpr)array, subscript);
}
case ArrayUpdateExpression aue:
{
Expr array = ExpressionToZ3Expr(aue.array);
Expr subscript = ExpressionToZ3Expr(aue.subscript);
Expr rhs = ExpressionToZ3Expr(aue.rhs);
Debug.Assert(array is ArrayExpr);
return ctx.MkStore((ArrayExpr)array, subscript, rhs);
}
case ITEExpression itee:
{
Expr cond = ExpressionToZ3Expr(itee.cond);
Expr thenExpr = ExpressionToZ3Expr(itee.thenExpr);
Expr elseExpr = ExpressionToZ3Expr(itee.elseExpr);
Debug.Assert(cond is BoolExpr);
return ctx.MkITE((BoolExpr)cond, thenExpr, elseExpr);
}
case NotExpression ne:
{
Expr expr = ExpressionToZ3Expr(ne.expression);
Debug.Assert(expr is BoolExpr);
return ctx.MkNot((BoolExpr)expr);
}
case NegExpression ne:
{
Expr expr = ExpressionToZ3Expr(ne.expression);
Debug.Assert(expr is ArithExpr);
return ctx.MkUnaryMinus((ArithExpr)expr);
}
case BinaryExpression be:
{
Expr le = ExpressionToZ3Expr(be.le);
Expr re = ExpressionToZ3Expr(be.re);
switch (be)
{
case MultiExpression:
Debug.Assert(le is ArithExpr);
Debug.Assert(re is ArithExpr);
return ctx.MkMul(new ArithExpr[] {
(ArithExpr)le,
(ArithExpr)re
});
case DivExpression:
if (le is IntExpr li)
{
if (re is IntExpr ri)
{
// 5 / 3 5 / -3 -5 / -3 -5 / 3
// C : 1 -1 1 -1
// Euclidean: 1 -1 2 -2
// (le div re) + (le >= 0 || le % re == 0 ? 0: (re > 0 ? - 1: 1))
return ctx.MkAdd(
ctx.MkDiv(li, ri),
(IntExpr)ctx.MkITE(
ctx.MkOr(
ctx.MkGe(li, ctx.MkInt(0)),
ctx.MkEq(ctx.MkMod(li, ri), ctx.MkInt(0))
),
ctx.MkInt(0),
ctx.MkITE(
ctx.MkGt(ri, ctx.MkInt(0)),
ctx.MkInt(-1),
ctx.MkInt(1)
)
)
);
}
}
else
{
if (le is RealExpr lr)
if (re is RealExpr rr)
return ctx.MkDiv(lr, rr);
}
throw new ArgumentException("The type between '/' must be both 'int' or both 'real'.");
case ModExpression:
Debug.Assert(le is IntExpr);
Debug.Assert(re is IntExpr);
// 5 % 3 5 % -3 -5 % -3 -5 % 3
// C : 2 2 -2 -2
// Euclidean: 2 2 1 1
// le > 0 ? (re > 0 ? (le mod re): (le mod -re) : (re > 0 ? -(le mod re): -(le mod -re))
return ctx.MkITE(
ctx.MkGt((IntExpr)le, ctx.MkInt(0)),
(IntExpr)ctx.MkITE(
ctx.MkGt((IntExpr)re, ctx.MkInt(0)),
ctx.MkMod((IntExpr)le, (IntExpr)re),
ctx.MkMod((IntExpr)le, (IntExpr)ctx.MkUnaryMinus((IntExpr)re))
),
(IntExpr)ctx.MkITE(
ctx.MkGt((IntExpr)re, ctx.MkInt(0)),
ctx.MkUnaryMinus(ctx.MkMod((IntExpr)le, (IntExpr)re)),
ctx.MkUnaryMinus(ctx.MkMod((IntExpr)le, (IntExpr)ctx.MkUnaryMinus((IntExpr)re)))
)
);
case AddExpression:
Debug.Assert(le is ArithExpr);
Debug.Assert(re is ArithExpr);
return ctx.MkAdd(new ArithExpr[] {
(ArithExpr)le,
(ArithExpr)re
});
case SubExpression:
Debug.Assert(le is ArithExpr);
Debug.Assert(re is ArithExpr);
return ctx.MkSub(new ArithExpr[] {
(ArithExpr)le,
(ArithExpr)re
});
case LTExpression:
Debug.Assert(le is ArithExpr);
Debug.Assert(re is ArithExpr);
return ctx.MkLt((ArithExpr)le, (ArithExpr)re);
case LEExpression:
Debug.Assert(le is ArithExpr);
Debug.Assert(re is ArithExpr);
return ctx.MkLe((ArithExpr)le, (ArithExpr)re);
case GTExpression:
Debug.Assert(le is ArithExpr);
Debug.Assert(re is ArithExpr);
return ctx.MkGt((ArithExpr)le, (ArithExpr)re);
case GEExpression:
Debug.Assert(le is ArithExpr);
Debug.Assert(re is ArithExpr);
return ctx.MkGe((ArithExpr)le, (ArithExpr)re);
case EQExpression:
Debug.Assert(le is ArithExpr);
Debug.Assert(re is ArithExpr);
return ctx.MkEq((ArithExpr)le, (ArithExpr)re);
case NEExpression:
Debug.Assert(le is ArithExpr);
Debug.Assert(re is ArithExpr);
return ctx.MkNot(ctx.MkEq((ArithExpr)le, (ArithExpr)re));
case AndExpression:
Debug.Assert(le is BoolExpr);
Debug.Assert(re is BoolExpr);
return ctx.MkAnd(new BoolExpr[] {
(BoolExpr)le,
(BoolExpr)re
});
case OrExpression:
Debug.Assert(le is BoolExpr);
Debug.Assert(re is BoolExpr);
return ctx.MkOr(new BoolExpr[] {
(BoolExpr)le,
(BoolExpr)re
});
case ImplicationExpression:
Debug.Assert(le is BoolExpr);
Debug.Assert(re is BoolExpr);
return ctx.MkImplies((BoolExpr)le, (BoolExpr)re);
case IffExpression:
Debug.Assert(le is BoolExpr);
Debug.Assert(re is BoolExpr);
return ctx.MkIff((BoolExpr)le, (BoolExpr)re);
case XorExpression:
Debug.Assert(le is BoolExpr);
Debug.Assert(re is BoolExpr);
return ctx.MkXor((BoolExpr)le, (BoolExpr)re);
}
Debug.Assert(false);
break;
}
case QuantifiedExpression qe:
Expr[] boundConstants = qe.vars.Values.Select<QuantifiedVariable, Expr>(
variable =>
{
switch (variable.type)
{
case IntType:
return ctx.MkIntConst(variable.name);
case FloatType:
return ctx.MkRealConst(variable.name);
case BoolType:
return ctx.MkBoolConst(variable.name);
default:
throw new ArgumentException($"there is a type of quantified variable that is not atomic type: {variable.type}");
}
}
).ToArray();
Expr body = ExpressionToZ3Expr(qe.expression);
if (qe is ForallQuantifiedExpression)
{
return ctx.MkForall(boundConstants, body);
}
else
{
Debug.Assert(qe is ExistsQuantifiedExpression);
return ctx.MkExists(boundConstants, body);
}
case LengthExpression le:
{
if (le.expression is VariableExpression ve)
{
Debug.Assert(ve.variable is ArrayVariable);
ArrayVariable av = (ArrayVariable)(ve.variable);
return ctx.MkIntConst(av.length.name);
}
else
{
Debug.Assert(le.expression is ArrayUpdateExpression);
LocalVariable variable = ((ArrayUpdateExpression)(le.expression)).length.variable;
Debug.Assert(variable.type is IntType);
return ctx.MkIntConst(variable.name);
}
}
}
Debug.Assert(false);
return null;
}
Dictionary<Predicate, Tuple<Expr, Expr[]>> predicates = new Dictionary<Predicate, Tuple<Expr, Expr[]>>();
public void definePredicate(Predicate predicate)
{
Expr expr = ExpressionToZ3Expr(predicate.expression);
Expr[] paraExprs = predicate.parameters.Select<LocalVariable, Expr>(
(parameter) =>
{
switch (parameter.type)
{
case IntType:
return ctx.MkIntConst(parameter.name);
case FloatType:
return ctx.MkRealConst(parameter.name);
case BoolType:
return ctx.MkBoolConst(parameter.name);
case ArrayType at:
switch (at.atomicType)
{
case IntType:
return ctx.MkArrayConst(parameter.name, ctx.IntSort, ctx.IntSort);
case FloatType:
return ctx.MkArrayConst(parameter.name, ctx.IntSort, ctx.RealSort);
case BoolType:
return ctx.MkArrayConst(parameter.name, ctx.IntSort, ctx.BoolSort);
default:
throw new ArgumentException("there's an atomic type that is neither 'int', 'float' or 'bool'. Probably a bug occurs.");
}
default:
throw new ArgumentException($"the type of parameter of {predicate.name} is neither int, float nor bool.");
}
}
).ToArray();
predicates.Add(predicate, Tuple.Create(expr, paraExprs));
}
}
}
================================================
FILE: cminor.csproj
================================================
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net6.0</TargetFramework>
<RootNamespace>cminor</RootNamespace>
<Antlr4UseCSharpGenerator>True</Antlr4UseCSharpGenerator>
<LangVersion>10.0</LangVersion>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Antlr4.CodeGenerator" Version="4.6.6">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="Antlr4.Runtime" Version="4.6.6" />
<PackageReference Include="CommandLineParser" Version="2.8.0" />
<PackageReference Include="Microsoft.Z3" Version="4.8.11" />
</ItemGroup>
</Project>
================================================
FILE: cminor.sln
================================================
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 16
VisualStudioVersion = 16.0.30114.105
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "cminor", "cminor.csproj", "{D19B789C-157A-467D-A250-8BB1A6748430}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Releas
gitextract_fxsz172g/ ├── .github/ │ └── workflows/ │ └── build-and-test.yml ├── .gitignore ├── .gitlab-ci.yml ├── .gitmodules ├── CMinorLexer.g4 ├── CMinorParser.g4 ├── COPYING ├── Doxyfile ├── Program.cs ├── backend/ │ ├── BasicPath.cs │ ├── CounterModel.cs │ ├── SMTSolver.cs │ ├── Verifier.cs │ └── Z3Solver.cs ├── cminor.csproj ├── cminor.sln ├── exception/ │ ├── ParsingException.cs │ └── ThrowingErrorListener.cs ├── frontend/ │ ├── AnnoGenerator.cs │ ├── CFGGenerator.cs │ ├── DeclGenerator.cs │ ├── ExprGenerator.cs │ ├── PredGenerator.cs │ ├── StmtGenerator.cs │ ├── Struct.cs │ ├── TermGenerator.cs │ └── Utils.cs ├── ir/ │ ├── Block.cs │ ├── Expression.cs │ ├── Statement.cs │ ├── TopLevel.cs │ ├── Type.cs │ └── Variable.cs ├── readme.md └── task-doc.md
SYMBOL INDEX (345 symbols across 23 files)
FILE: Program.cs
class Program (line 24) | class Program
class Options (line 26) | class Options
method Main (line 55) | static void Main(string[] args)
method RunOptions (line 71) | static void RunOptions(Options opts)
FILE: backend/BasicPath.cs
class BasicPath (line 16) | class BasicPath
method ObjectInvariant (line 28) | [ContractInvariantMethod]
FILE: backend/CounterModel.cs
class CounterModel (line 16) | class CounterModel
method CounterModel (line 24) | public CounterModel(Dictionary<string, string> assignments)
method Print (line 31) | public void Print(TextWriter writer)
FILE: backend/SMTSolver.cs
class SMTSolver (line 20) | class SMTSolver
method CheckValid (line 30) | public CounterModel? CheckValid(Expression expression)
method definePredicate (line 38) | public void definePredicate(Predicate predicate)
FILE: backend/Verifier.cs
class Verifier (line 26) | class Verifier
method Verifier (line 31) | public Verifier(TextWriter writer)
method Apply (line 44) | public int Apply(IRMain cfg)
FILE: backend/Z3Solver.cs
class Z3Solver (line 21) | class Z3Solver
method Z3Solver (line 27) | public Z3Solver()
method CheckValid (line 35) | public CounterModel? CheckValid(Expression expression)
method ExpressionToZ3Expr (line 63) | Expr ExpressionToZ3Expr(Expression e)
method definePredicate (line 351) | public void definePredicate(Predicate predicate)
FILE: exception/ParsingException.cs
class ParsingException (line 18) | public class ParsingException : Exception
method ParsingException (line 20) | public ParsingException() { }
method ParsingException (line 21) | public ParsingException(string message) : base(message) { }
method ParsingException (line 22) | public ParsingException(string message, Exception inner) : base(messag...
method ParsingException (line 24) | public ParsingException([NotNull] ParserRuleContext context, string me...
FILE: exception/ThrowingErrorListener.cs
class ThrowingErrorListener (line 16) | public class ThrowingErrorListener : BaseErrorListener
method SyntaxError (line 18) | public override void SyntaxError([NotNull] IRecognizer recognizer, [Nu...
FILE: frontend/AnnoGenerator.cs
class CFGGenerator (line 27) | partial class CFGGenerator : CMinorParserBaseVisitor<Expression?>
method VisitAssertion (line 29) | public override Expression? VisitAssertion([NotNull] CMinorParser.Asse...
method CalcPreconditionBlock (line 44) | PreconditionBlock
method CalcLoopHeadBlock (line 60) | LoopHeadBlock CalcLoopHeadBlock([NotNull] CMinorParser.LoopAnnotContex...
method CalcPostconditionBlock (line 78) | PostconditionBlock CalcPostconditionBlock([NotNull] CMinorParser.Ensur...
FILE: frontend/CFGGenerator.cs
class CFGGenerator (line 48) | partial class CFGGenerator : CMinorParserBaseVisitor<Expression?>
method Apply (line 72) | public IRMain Apply([NotNull] CMinorParser.MainContext context)
method VisitMain (line 164) | public override Expression? VisitMain([NotNull] CMinorParser.MainConte...
method VisitFuncDef (line 171) | public override Expression? VisitFuncDef([NotNull] CMinorParser.FuncDe...
method VisitStructDef (line 234) | public override Expression? VisitStructDef([NotNull] CMinorParser.Stru...
method VisitPredDef (line 258) | public override Expression? VisitPredDef([NotNull] CMinorParser.PredDe...
method CalcDefName (line 290) | string CalcDefName(ParserRuleContext context, ITerminalNode node)
FILE: frontend/DeclGenerator.cs
class CFGGenerator (line 17) | partial class CFGGenerator: CMinorParserBaseVisitor<Expression?>
method VisitDecl (line 19) | public override Expression? VisitDecl([NotNull] CMinorParser.DeclConte...
FILE: frontend/ExprGenerator.cs
class CFGGenerator (line 19) | partial class CFGGenerator : CMinorParserBaseVisitor<Expression?>
method VisitIdentExpr (line 21) | public override Expression VisitIdentExpr([NotNull] CMinorParser.Ident...
method VisitConstExpr (line 27) | public override Expression VisitConstExpr([NotNull] CMinorParser.Const...
method VisitCallExpr (line 32) | public override Expression? VisitCallExpr([NotNull] CMinorParser.CallE...
method VisitParExpr (line 149) | public override Expression? VisitParExpr([NotNull] CMinorParser.ParExp...
method VisitArrAccessExpr (line 154) | public override Expression VisitArrAccessExpr([NotNull] CMinorParser.A...
method VisitMemExpr (line 180) | public override Expression VisitMemExpr([NotNull] CMinorParser.MemExpr...
method VisitUnaryExpr (line 216) | public override Expression VisitUnaryExpr([NotNull] CMinorParser.Unary...
method VisitMulExpr (line 238) | public override Expression VisitMulExpr([NotNull] CMinorParser.MulExpr...
method VisitAddExpr (line 288) | public override Expression VisitAddExpr([NotNull] CMinorParser.AddExpr...
method VisitOrdExpr (line 310) | public override Expression VisitOrdExpr([NotNull] CMinorParser.OrdExpr...
method VisitEquExpr (line 323) | public override Expression VisitEquExpr([NotNull] CMinorParser.EquExpr...
method VisitAndExpr (line 341) | public override Expression VisitAndExpr([NotNull] CMinorParser.AndExpr...
method VisitOrExpr (line 349) | public override Expression VisitOrExpr([NotNull] CMinorParser.OrExprCo...
method VisitConstant (line 357) | public override Expression VisitConstant([NotNull] CMinorParser.Consta...
FILE: frontend/PredGenerator.cs
class CFGGenerator (line 20) | partial class CFGGenerator : CMinorParserBaseVisitor<Expression?>
method VisitTruePred (line 22) | public override Expression VisitTruePred([NotNull] CMinorParser.TruePr...
method VisitFalsePred (line 27) | public override Expression VisitFalsePred([NotNull] CMinorParser.False...
method VisitCmpPred (line 32) | public override Expression VisitCmpPred([NotNull] CMinorParser.CmpPred...
method VisitCallPred (line 57) | public override Expression VisitCallPred([NotNull] CMinorParser.CallPr...
method VisitParPred (line 95) | public override Expression? VisitParPred([NotNull] CMinorParser.ParPre...
method VisitConPred (line 100) | public override Expression VisitConPred([NotNull] CMinorParser.ConPred...
method VisitDisPred (line 108) | public override Expression VisitDisPred([NotNull] CMinorParser.DisPred...
method VisitImpPred (line 116) | public override Expression VisitImpPred([NotNull] CMinorParser.ImpPred...
method VisitIffPred (line 124) | public override Expression VisitIffPred([NotNull] CMinorParser.IffPred...
method VisitNegPred (line 132) | public override Expression VisitNegPred([NotNull] CMinorParser.NegPred...
method VisitXorPred (line 139) | public override Expression VisitXorPred([NotNull] CMinorParser.XorPred...
method VisitLengthPred (line 147) | public override Expression VisitLengthPred([NotNull] CMinorParser.Leng...
method VisitQuantiPred (line 159) | public override Expression VisitQuantiPred([NotNull] CMinorParser.Quan...
FILE: frontend/StmtGenerator.cs
class CFGGenerator (line 18) | partial class CFGGenerator : CMinorParserBaseVisitor<Expression?>
method VisitExprStmt (line 20) | public override Expression? VisitExprStmt([NotNull] CMinorParser.ExprS...
method VisitIfStmt (line 32) | public override Expression? VisitIfStmt([NotNull] CMinorParser.IfStmtC...
method VisitWhileStmt (line 83) | public override Expression? VisitWhileStmt([NotNull] CMinorParser.Whil...
method VisitForStmt (line 148) | public override Expression? VisitForStmt([NotNull] CMinorParser.ForStm...
method VisitDoStmt (line 244) | public override Expression? VisitDoStmt([NotNull] CMinorParser.DoStmtC...
method VisitBreakStmt (line 295) | public override Expression? VisitBreakStmt([NotNull] CMinorParser.Brea...
method VisitContStmt (line 308) | public override Expression? VisitContStmt([NotNull] CMinorParser.ContS...
method VisitReturnStmt (line 321) | public override Expression? VisitReturnStmt([NotNull] CMinorParser.Ret...
method VisitBlockStmt (line 346) | public override Expression? VisitBlockStmt([NotNull] CMinorParser.Bloc...
method VisitVarAssign (line 358) | public override Expression? VisitVarAssign([NotNull] CMinorParser.VarA...
method VisitSubAssign (line 369) | public override Expression? VisitSubAssign([NotNull] CMinorParser.SubA...
method VisitMemAssign (line 406) | public override Expression? VisitMemAssign([NotNull] CMinorParser.MemA...
method Assign (line 438) | void Assign(LocalVariable lhsVariable, [NotNull] CMinorParser.ExprCont...
FILE: frontend/Struct.cs
class Struct (line 20) | class Struct
method Struct (line 27) | public Struct(string name, SortedDictionary<string, MemberVariable> me...
method Print (line 34) | public void Print(TextWriter writer)
class StructType (line 44) | sealed class StructType : VarType
method StructType (line 50) | private StructType(Struct structDefinition)
method Get (line 55) | public static StructType Get(Struct structDefinition)
method ToString (line 64) | public override string ToString()
class StructVariable (line 71) | class StructVariable : LocalVariable
method ObjectInvariant (line 75) | [ContractInvariantMethod]
method StructVariable (line 81) | public StructVariable(StructType type, string name)
FILE: frontend/TermGenerator.cs
class CFGGenerator (line 18) | partial class CFGGenerator : CMinorParserBaseVisitor<Expression?>
method VisitIdentTerm (line 20) | public override Expression VisitIdentTerm([NotNull] CMinorParser.Ident...
method VisitResTerm (line 26) | public override Expression VisitResTerm([NotNull] CMinorParser.ResTerm...
method VisitConstTerm (line 32) | public override Expression VisitConstTerm([NotNull] CMinorParser.Const...
method VisitParArithTerm (line 37) | public override Expression? VisitParArithTerm([NotNull] CMinorParser.P...
method VisitParTerm (line 42) | public override Expression? VisitParTerm([NotNull] CMinorParser.ParTer...
method VisitArrAccessTerm (line 47) | public override Expression VisitArrAccessTerm([NotNull] CMinorParser.A...
method VisitMemTerm (line 57) | public override Expression VisitMemTerm([NotNull] CMinorParser.MemTerm...
method VisitUnaryTerm (line 93) | public override Expression VisitUnaryTerm([NotNull] CMinorParser.Unary...
method VisitMulTerm (line 115) | public override Expression VisitMulTerm([NotNull] CMinorParser.MulTerm...
method VisitAddTerm (line 152) | public override Expression VisitAddTerm([NotNull] CMinorParser.AddTerm...
method VisitOrdTerm (line 165) | public override Expression VisitOrdTerm([NotNull] CMinorParser.OrdTerm...
method VisitEquTerm (line 178) | public override Expression VisitEquTerm([NotNull] CMinorParser.EquTerm...
method VisitAndTerm (line 191) | public override Expression VisitAndTerm([NotNull] CMinorParser.AndTerm...
method VisitOrTerm (line 199) | public override Expression VisitOrTerm([NotNull] CMinorParser.OrTermCo...
method VisitArrUpdTerm (line 207) | public override Expression VisitArrUpdTerm([NotNull] CMinorParser.ArrU...
method VisitLogicConstant (line 247) | public override Expression VisitLogicConstant([NotNull] CMinorParser.L...
FILE: frontend/Utils.cs
class CFGGenerator (line 24) | partial class CFGGenerator : CMinorParserBaseVisitor<Expression?>
method CalcType (line 26) | VarType CalcType(string type, bool isArray)
method CalcVar (line 50) | LocalVariable CalcVar([NotNull] ParserRuleContext context, string name...
method CalcLocalVar (line 89) | LocalVariable CalcLocalVar([NotNull] CMinorParser.LocalVarContext cont...
method CalcParaVar (line 116) | LocalVariable CalcParaVar([NotNull] CMinorParser.ParaVarContext context)
method CalcLogicParaVar (line 126) | LocalVariable CalcLogicParaVar([NotNull] CMinorParser.LogicParaVarCont...
method CalcRetVar (line 136) | LocalVariable CalcRetVar([NotNull] CMinorParser.RetVarContext context)
method TypeConfirm (line 145) | Expression TypeConfirm([NotNull] ParserRuleContext context, bool boolA...
method FindVariable (line 163) | LocalVariable FindVariable([NotNull] ParserRuleContext context, string...
method LocalVariableExists (line 175) | bool LocalVariableExists(string name)
method NotNullConfirm (line 184) | Expression NotNullConfirm([NotNull] ParserRuleContext context)
method CompressedExpression (line 198) | VariableExpression CompressedExpression(Expression expression, Func<st...
class Counter (line 220) | public class Counter
method GetVariable (line 226) | public string GetVariable(string variable)
method GetCall (line 236) | public string GetCall(string variable)
method GetCondition (line 247) | public string GetCondition()
method GetArray (line 256) | public string GetArray()
method GetArg (line 263) | public string GetArg()
method GetSub (line 271) | public string GetSub()
method GetLength (line 279) | public static string GetLength(string variable)
method GetDivisor (line 288) | public string GetDivisor()
FILE: ir/Block.cs
class Block (line 19) | abstract class Block
method AddEdge (line 24) | static public void AddEdge(Block from, Block to)
method AddStatement (line 33) | public void AddStatement(Statement statement)
method Block (line 38) | public Block() { }
method Block (line 39) | public Block(Function currentFunction, Block? predecessor)
method Print (line 46) | public abstract void Print(TextWriter writer);
method PrintPredecessors (line 47) | protected void PrintPredecessors(TextWriter writer)
method PrintSuccessors (line 54) | protected void PrintSuccessors(TextWriter writer)
method PrintCondition (line 61) | protected void PrintCondition(TextWriter writer, string name, Expressi...
method PrintStatements (line 68) | protected void PrintStatements(TextWriter writer)
class BasicBlock (line 76) | sealed class BasicBlock : Block
method Print (line 81) | public override void Print(TextWriter writer)
method BasicBlock (line 91) | public BasicBlock(Function currentFunction, Block? predecessor = null)
method ToString (line 94) | public override string ToString() => $"_BASIC#{number}";
class PostconditionBlock (line 97) | sealed class PostconditionBlock : Block
method ObjectInvariant (line 104) | [ContractInvariantMethod]
method Print (line 112) | public override void Print(TextWriter writer)
method ToString (line 122) | public override string ToString() => $"_POSTCOND#{number}";
class HeadBlock (line 126) | abstract class HeadBlock : Block
method HeadBlock (line 130) | public HeadBlock() { }
method HeadBlock (line 131) | public HeadBlock(Function currentFunction, Block? predecessor)
method PrintRankingFunction (line 134) | abstract protected void PrintRankingFunction(TextWriter writer);
class PreconditionBlock (line 138) | sealed class PreconditionBlock : HeadBlock
method ObjectInvariant (line 145) | [ContractInvariantMethod]
method Print (line 155) | public override void Print(TextWriter writer)
method PrintRankingFunction (line 167) | protected override void PrintRankingFunction(TextWriter writer)
method ToString (line 179) | public override string ToString() => $"_PRECOND#{number}";
class LoopHeadBlock (line 183) | sealed class LoopHeadBlock : HeadBlock
method LoopHeadBlock (line 192) | public LoopHeadBlock(Function currentFunction, Block? predecessor = null)
method ObjectInvariant (line 195) | [ContractInvariantMethod]
method Print (line 202) | public override void Print(TextWriter writer)
method PrintRankingFunction (line 217) | protected override void PrintRankingFunction(TextWriter writer)
method ToString (line 229) | public override string ToString() => $"_LOOPHEAD#{number}";
FILE: ir/Expression.cs
class Expression (line 27) | abstract class Expression
method Print (line 31) | public abstract void Print(TextWriter writer);
method Substitute (line 33) | public abstract Expression Substitute(LocalVariable s, Expression t);
method GetFreeVariables (line 35) | public abstract HashSet<LocalVariable> GetFreeVariables();
method ObjectInvariant (line 37) | [ContractInvariantMethod]
class VariableExpression (line 49) | sealed class VariableExpression : Expression
method VariableExpression (line 53) | public VariableExpression(LocalVariable variable)
method Print (line 59) | public override void Print(TextWriter writer)
method Substitute (line 64) | public override Expression Substitute(LocalVariable s, Expression t)
method GetFreeVariables (line 77) | public override HashSet<LocalVariable> GetFreeVariables()
class ConstantExpression (line 83) | abstract class ConstantExpression : Expression
method Substitute (line 85) | public override Expression Substitute(LocalVariable s, Expression t)
method GetFreeVariables (line 90) | public override HashSet<LocalVariable> GetFreeVariables()
class IntConstantExpression (line 96) | sealed class IntConstantExpression : ConstantExpression
method IntConstantExpression (line 100) | public IntConstantExpression(int constant)
method Print (line 106) | public override void Print(TextWriter writer)
class FloatConstantExpression (line 112) | sealed class FloatConstantExpression : ConstantExpression
method FloatConstantExpression (line 116) | public FloatConstantExpression(float constant)
method Print (line 122) | public override void Print(TextWriter writer)
class BoolConstantExpression (line 128) | sealed class BoolConstantExpression : ConstantExpression
method BoolConstantExpression (line 132) | public BoolConstantExpression(bool constant)
method Print (line 138) | public override void Print(TextWriter writer)
class FunctionCallExpression (line 147) | sealed class FunctionCallExpression
method ObjectInvariant (line 152) | [ContractInvariantMethod]
method Print (line 158) | public void Print(TextWriter writer)
class ArrayAccessExpression (line 170) | sealed class ArrayAccessExpression : Expression
method ArrayAccessExpression (line 175) | public ArrayAccessExpression(Expression array, Expression subscript)
method Print (line 185) | public override void Print(TextWriter writer)
method Substitute (line 193) | public override Expression Substitute(LocalVariable s, Expression t)
method GetFreeVariables (line 198) | public override HashSet<LocalVariable> GetFreeVariables()
class ArrayUpdateExpression (line 206) | sealed class ArrayUpdateExpression : Expression
method ArrayUpdateExpression (line 216) | public ArrayUpdateExpression(Expression array, Expression subscript, E...
method Print (line 230) | public override void Print(TextWriter writer)
method Substitute (line 240) | public override Expression Substitute(LocalVariable s, Expression t)
method GetFreeVariables (line 257) | public override HashSet<LocalVariable> GetFreeVariables()
class ITEExpression (line 266) | sealed class ITEExpression : Expression
method ITEExpression (line 271) | public ITEExpression(Expression cond, Expression thenExpr, Expression ...
method Print (line 282) | public override void Print(TextWriter writer)
method Substitute (line 291) | public override Expression Substitute(LocalVariable s, Expression t)
method GetFreeVariables (line 299) | public override HashSet<LocalVariable> GetFreeVariables()
class UnaryExpression (line 308) | abstract class UnaryExpression : Expression
method GetFreeVariables (line 312) | public override HashSet<LocalVariable> GetFreeVariables()
method Substitute (line 317) | public override Expression Substitute(LocalVariable s, Expression t)
class NotExpression (line 328) | sealed class NotExpression : UnaryExpression
method NotExpression (line 330) | public NotExpression(Expression expression)
method Print (line 336) | public override void Print(TextWriter writer)
class NegExpression (line 343) | sealed class NegExpression : UnaryExpression
method NegExpression (line 345) | public NegExpression(Expression expression)
method Print (line 351) | public override void Print(TextWriter writer)
class BinaryExpression (line 358) | abstract class BinaryExpression : Expression
method Print (line 364) | public override void Print(TextWriter writer)
method Substitute (line 374) | public override Expression Substitute(LocalVariable s, Expression t)
method GetFreeVariables (line 385) | public override HashSet<LocalVariable> GetFreeVariables()
method FromOp (line 392) | public static BinaryExpression FromOp(string op, Expression le, Expres...
class MultiExpression (line 408) | sealed class MultiExpression : BinaryExpression
method GetOperator (line 410) | public static string GetOperator() => "*";
method MultiExpression (line 412) | public MultiExpression(Expression le, Expression re)
class DivExpression (line 421) | sealed class DivExpression : BinaryExpression
method GetOperator (line 423) | public static string GetOperator() => "/";
method DivExpression (line 425) | public DivExpression(Expression le, Expression re)
class ModExpression (line 434) | sealed class ModExpression : BinaryExpression
method GetOperator (line 436) | public static string GetOperator() => "%";
method ModExpression (line 438) | public ModExpression(Expression le, Expression re)
class AddExpression (line 447) | sealed class AddExpression : BinaryExpression
method GetOperator (line 449) | public static string GetOperator() => "+";
method AddExpression (line 451) | public AddExpression(Expression le, Expression re)
class SubExpression (line 460) | sealed class SubExpression : BinaryExpression
method GetOperator (line 462) | public static string GetOperator() => "-";
method SubExpression (line 464) | public SubExpression(Expression le, Expression re)
class LTExpression (line 473) | sealed class LTExpression : BinaryExpression
method GetOperator (line 475) | public static string GetOperator() => "<";
method LTExpression (line 477) | public LTExpression(Expression le, Expression re)
class LEExpression (line 486) | sealed class LEExpression : BinaryExpression
method GetOperator (line 488) | public static string GetOperator() => "<=";
method LEExpression (line 490) | public LEExpression(Expression le, Expression re)
class GTExpression (line 499) | sealed class GTExpression : BinaryExpression
method GetOperator (line 501) | public static string GetOperator() => ">";
method GTExpression (line 503) | public GTExpression(Expression le, Expression re)
class GEExpression (line 512) | sealed class GEExpression : BinaryExpression
method GetOperator (line 514) | public static string GetOperator() => ">=";
method GEExpression (line 516) | public GEExpression(Expression le, Expression re)
class EQExpression (line 525) | sealed class EQExpression : BinaryExpression
method GetOperator (line 527) | public static string GetOperator() => "==";
method EQExpression (line 529) | public EQExpression(Expression le, Expression re)
class NEExpression (line 538) | sealed class NEExpression : BinaryExpression
method GetOperator (line 540) | public static string GetOperator() => "!=";
method NEExpression (line 542) | public NEExpression(Expression le, Expression re)
class AndExpression (line 551) | sealed class AndExpression : BinaryExpression
method GetOperator (line 553) | public static string GetOperator() => "&&";
method AndExpression (line 555) | public AndExpression(Expression le, Expression re)
class OrExpression (line 564) | sealed class OrExpression : BinaryExpression
method GetOperator (line 566) | public static string GetOperator() => "||";
method OrExpression (line 568) | public OrExpression(Expression le, Expression re)
class LengthExpression (line 577) | sealed class LengthExpression : UnaryExpression
method ObjectInvariant (line 579) | [ContractInvariantMethod]
method LengthExpression (line 586) | public LengthExpression(Expression expression)
method Print (line 593) | public override void Print(TextWriter writer)
method Substitute (line 600) | public override Expression Substitute(LocalVariable s, Expression t)
class QuantifiedExpression (line 626) | abstract class QuantifiedExpression : Expression
method QuantifiedExpression (line 632) | public QuantifiedExpression(Dictionary<string, QuantifiedVariable> var...
method Print (line 639) | public override void Print(TextWriter writer)
method GetQuantifier (line 654) | protected abstract string GetQuantifier();
method Substitute (line 656) | public override Expression Substitute(LocalVariable s, Expression t)
method GetFreeVariables (line 674) | public override HashSet<LocalVariable> GetFreeVariables()
class ForallQuantifiedExpression (line 680) | sealed class ForallQuantifiedExpression : QuantifiedExpression
method ForallQuantifiedExpression (line 682) | public ForallQuantifiedExpression(Dictionary<string, QuantifiedVariabl...
method GetQuantifier (line 684) | protected override string GetQuantifier() => "forall";
class ExistsQuantifiedExpression (line 687) | sealed class ExistsQuantifiedExpression : QuantifiedExpression
method ExistsQuantifiedExpression (line 689) | public ExistsQuantifiedExpression(Dictionary<string, QuantifiedVariabl...
method GetQuantifier (line 691) | protected override string GetQuantifier() => "exists";
class ImplicationExpression (line 694) | sealed class ImplicationExpression : BinaryExpression
method GetOperator (line 696) | public static string GetOperator() => "==>";
method ImplicationExpression (line 698) | public ImplicationExpression(Expression le, Expression re)
class IffExpression (line 707) | sealed class IffExpression : BinaryExpression
method GetOperator (line 709) | public static string GetOperator() => "<==>";
method IffExpression (line 711) | public IffExpression(Expression le, Expression re)
class XorExpression (line 720) | sealed class XorExpression : BinaryExpression
method GetOperator (line 722) | public static string GetOperator() => "^^";
method XorExpression (line 724) | public XorExpression(Expression le, Expression re)
class PredicateCallExpression (line 733) | sealed class PredicateCallExpression : Expression
method PredicateCallExpression (line 738) | public PredicateCallExpression(Predicate predicate, List<Expression> a...
method ObjectInvariant (line 745) | [ContractInvariantMethod]
method Print (line 751) | public override void Print(TextWriter writer)
method Substitute (line 762) | public override Expression Substitute(LocalVariable s, Expression t)
method GetFreeVariables (line 771) | public override HashSet<LocalVariable> GetFreeVariables()
FILE: ir/Statement.cs
class Statement (line 31) | abstract class Statement
method Statement (line 38) | public Statement()
method Print (line 44) | public abstract void Print(TextWriter writer);
class AssignStatement (line 47) | abstract class AssignStatement : Statement
class VariableAssignStatement (line 54) | sealed class VariableAssignStatement : AssignStatement
method ObjectInvariant (line 58) | [ContractInvariantMethod]
method Print (line 65) | public override void Print(TextWriter writer)
class SubscriptAssignStatement (line 73) | sealed class SubscriptAssignStatement : AssignStatement
method ObjectInvariant (line 78) | [ContractInvariantMethod]
method Print (line 85) | public override void Print(TextWriter writer)
class FunctionCallStatement (line 95) | sealed class FunctionCallStatement : Statement
method Print (line 100) | public override void Print(TextWriter writer)
class AssertStatement (line 116) | sealed class AssertStatement : Statement
method Print (line 120) | public override void Print(TextWriter writer)
class AssumeStatement (line 128) | sealed class AssumeStatement : Statement
method Print (line 132) | public override void Print(TextWriter writer)
FILE: ir/TopLevel.cs
class IRMain (line 18) | class IRMain
method Print (line 23) | public void Print(TextWriter writer)
class Function (line 44) | class Function
method Print (line 65) | public void Print(TextWriter writer)
class Predicate (line 87) | class Predicate
method Print (line 97) | public void Print(TextWriter writer)
FILE: ir/Type.cs
class Type (line 32) | abstract class Type { }
class VarType (line 34) | abstract class VarType : Type { }
class AtomicType (line 38) | abstract class AtomicType : VarType
method FromString (line 40) | public static AtomicType FromString(string s)
class IntType (line 64) | sealed class IntType : AtomicType
method IntType (line 68) | private IntType() { }
method Get (line 70) | public static IntType Get()
method ToString (line 75) | public override string ToString()
class FloatType (line 81) | sealed class FloatType : AtomicType
method FloatType (line 85) | private FloatType() { }
method Get (line 87) | public static FloatType Get()
method ToString (line 92) | public override string ToString()
class BoolType (line 98) | sealed class BoolType : AtomicType
method BoolType (line 102) | private BoolType() { }
method Get (line 104) | public static BoolType Get()
method ToString (line 109) | public override string ToString()
class ArrayType (line 115) | sealed class ArrayType : VarType
method ArrayType (line 123) | private ArrayType(AtomicType atomicType)
method Get (line 128) | public static ArrayType Get(AtomicType atomicType)
method ToString (line 145) | public override string ToString()
class FunType (line 151) | class FunType : Type
method FunType (line 158) | private FunType(List<VarType> returnTypes, List<VarType> paraTypes)
method Get (line 164) | public static FunType Get(List<VarType> returnTypes, List<VarType> par...
method ToString (line 192) | public override string ToString()
class PredType (line 216) | sealed class PredType : Type
method PredType (line 222) | private PredType(List<VarType> paraTypes)
method Get (line 227) | public static PredType Get(List<VarType> paraTypes)
method ToString (line 249) | public override string ToString()
FILE: ir/Variable.cs
class Variable (line 18) | abstract class Variable
class LocalVariable (line 25) | class LocalVariable : Variable { }
class ArrayVariable (line 27) | class ArrayVariable : LocalVariable
class QuantifiedVariable (line 33) | sealed class QuantifiedVariable : LocalVariable { }
class MemberVariable (line 37) | sealed class MemberVariable : Variable { }
Condensed preview — 35 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (376K chars).
[
{
"path": ".github/workflows/build-and-test.yml",
"chars": 1201,
"preview": "name: Build and Test\non: [push, pull_request]\njobs:\n Build-and-Test:\n runs-on: ubuntu-latest\n\n steps:\n - uses:"
},
{
"path": ".gitignore",
"chars": 6329,
"preview": "## Ignore Visual Studio temporary files, build results, and\n## files generated by popular Visual Studio add-ons.\n\n# User"
},
{
"path": ".gitlab-ci.yml",
"chars": 833,
"preview": "image: autojudger22\ncache:\n key: \"$CI_COMMIT_SHA\"\n paths:\n - bin/\n - testcases/\n\nstages:\n - build\n - prepare_d"
},
{
"path": ".gitmodules",
"chars": 108,
"preview": "[submodule \"testcases\"]\n\tpath = testcases\n\turl = git@github.com:thufv/CMinor-testcases.git\n\tbranch = master\n"
},
{
"path": "CMinorLexer.g4",
"chars": 1895,
"preview": "/*\n * This lexer grammar only targets C#.\n */\n\nlexer grammar CMinorLexer;\n\n@header {#pragma warning disable 3021}\n\n@prei"
},
{
"path": "CMinorParser.g4",
"chars": 4527,
"preview": "/*\n * compatible with ACSL language grammar v1.17\n */\n\nparser grammar CMinorParser;\n\noptions {\n\ttokenVocab = CMinorLexer"
},
{
"path": "COPYING",
"chars": 35149,
"preview": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free "
},
{
"path": "Doxyfile",
"chars": 117503,
"preview": "# Doxyfile 1.9.3\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org) "
},
{
"path": "Program.cs",
"chars": 4443,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "backend/BasicPath.cs",
"chars": 1424,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "backend/CounterModel.cs",
"chars": 1611,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "backend/SMTSolver.cs",
"chars": 1631,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "backend/Verifier.cs",
"chars": 1532,
"preview": "\n/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or mod"
},
{
"path": "backend/Z3Solver.cs",
"chars": 18614,
"preview": "/* Copyright 2022 Xingyu Xie, Jiangyi Liu\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute i"
},
{
"path": "cminor.csproj",
"chars": 824,
"preview": "<Project Sdk=\"Microsoft.NET.Sdk\">\r\n\r\n <PropertyGroup>\r\n <OutputType>Exe</OutputType>\r\n <TargetFramework>net6.0</T"
},
{
"path": "cminor.sln",
"chars": 986,
"preview": "\r\nMicrosoft Visual Studio Solution File, Format Version 12.00\r\n# Visual Studio Version 16\r\nVisualStudioVersion = 16.0.3"
},
{
"path": "exception/ParsingException.cs",
"chars": 1165,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "exception/ThrowingErrorListener.cs",
"chars": 1107,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "frontend/AnnoGenerator.cs",
"chars": 3639,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "frontend/CFGGenerator.cs",
"chars": 12848,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "frontend/DeclGenerator.cs",
"chars": 1305,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "frontend/ExprGenerator.cs",
"chars": 17033,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "frontend/PredGenerator.cs",
"chars": 9050,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "frontend/StmtGenerator.cs",
"chars": 18155,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "frontend/Struct.cs",
"chars": 3668,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "frontend/TermGenerator.cs",
"chars": 12627,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "frontend/Utils.cs",
"chars": 11219,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "ir/Block.cs",
"chars": 7359,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "ir/Expression.cs",
"chars": 24554,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "ir/Statement.cs",
"chars": 4231,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "ir/TopLevel.cs",
"chars": 3835,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "ir/Type.cs",
"chars": 7889,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "ir/Variable.cs",
"chars": 1554,
"preview": "/* Copyright 2022 Xingyu Xie\n\nThis file is part of CMinor.\n\nCMinor is free software: you can redistribute it and/or modi"
},
{
"path": "readme.md",
"chars": 3117,
"preview": "\n\n## 简介\n\n本项目为 2022 年春季学期清华大学《软件分析与验证》课程实验平台，作业平台提供了一个 CMinor 的验证框架，你需要在其中实现核心的验证算法。CMinor 是一个面向验证的教学语言，其包括"
},
{
"path": "task-doc.md",
"chars": 6657,
"preview": "# 课程大作业任务说明文档\n\n## 任务说明\n\n这里是 2021-2022 年春季学期**软件分析与验证**课程大作业任务说明文档，本次课程大作业的目标是完成一个具有以下功能的程序验证工具：\n\n- 对于给定的带有部分正确性验证标注的输入程序"
}
]
About this extraction
This page contains the full source code of the thufv/CMinor-Verifier GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 35 files (341.4 KB), approximately 79.4k tokens, and a symbol index with 345 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.