From c8b0715025f560083d674adc5bfb6224d620b672 Mon Sep 17 00:00:00 2001 From: Daniel Steuer Date: Fri, 27 May 2022 22:39:01 +0200 Subject: [PATCH 01/13] scripts: switch from sh to bash to increase compatibility --- docker4bots/2_run_debug_container.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker4bots/2_run_debug_container.sh b/docker4bots/2_run_debug_container.sh index b234058..23ee47f 100755 --- a/docker4bots/2_run_debug_container.sh +++ b/docker4bots/2_run_debug_container.sh @@ -1,4 +1,4 @@ -#!/bin/sh +#!/bin/bash source $(dirname $0)/config.sh From 077784aa9e9f5a9b5325f0a40a6508034ffad181 Mon Sep 17 00:00:00 2001 From: Daniel Steuer Date: Fri, 27 May 2022 23:35:50 +0200 Subject: [PATCH 02/13] python compile container: add Dockercontainer for 'building' python code --- docker4bots/spn_python_base/Dockerfile | 19 +++++++++++++ docker4bots/spn_python_base/bot_wrapper.sh | 33 ++++++++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 docker4bots/spn_python_base/Dockerfile create mode 100755 docker4bots/spn_python_base/bot_wrapper.sh diff --git a/docker4bots/spn_python_base/Dockerfile b/docker4bots/spn_python_base/Dockerfile new file mode 100644 index 0000000..7eb3877 --- /dev/null +++ b/docker4bots/spn_python_base/Dockerfile @@ -0,0 +1,19 @@ +FROM alpine + +RUN apk add --no-cache python3 py3-pip doxygen + +RUN addgroup -S spnbot && adduser --uid 1337 --home /spnbot -S spnbot --shell /bin/sh -G spnbot + +ADD bot_wrapper.sh / + +ADD spn_python_framework/ /spnbot/spn_python_framework + +# pre-build framework, hand it over to the spnbot user and create the shared memory directory +# (all in one step to save layers) +RUN cd /spnbot/spn_python_framework && chown -R spnbot /spnbot && mkdir /spnshm +VOLUME /spnshm +VOLUME /spndata + +USER spnbot + +ENTRYPOINT ["/bot_wrapper.sh"] diff --git a/docker4bots/spn_python_base/bot_wrapper.sh b/docker4bots/spn_python_base/bot_wrapper.sh new file mode 100755 index 0000000..486eae7 --- /dev/null +++ b/docker4bots/spn_python_base/bot_wrapper.sh @@ -0,0 +1,33 @@ +#!/bin/sh -e + +action="$1" + +echo "Hello from the SPN Python container!" + +case "$action" in + compile) + # copy the code in, build and move the binary out + cd /spnbot/spn_python_framework/ + + # copy template code into production container + + chmod +x /spndata/main.py + ;; + + run) + # run the bot and allow coredumps + ulimit -c unlimited + cd /spndata/ + ./usercode.py + ;; + + doc) + cd /spnbot/spn_python_framework/ + doxygen Doxyfile + mv doc/html/* /doc + ;; + + *) + echo "Invalid action: $action" + exit 1 +esac From b2a03051ebb768b276bbd7e660c80c9c8927c926 Mon Sep 17 00:00:00 2001 From: Daniel Steuer Date: Fri, 27 May 2022 23:37:34 +0200 Subject: [PATCH 03/13] python compile container: add abstraction api --- docker4bots/spn_python_base/bot_wrapper.sh | 4 +- .../spn_python_framework/src/api.py | 408 ++++++++++++++++++ .../spn_python_framework/src/main.py | 55 +++ .../spn_python_framework/src/usercode.py | 0 4 files changed, 466 insertions(+), 1 deletion(-) create mode 100644 docker4bots/spn_python_base/spn_python_framework/src/api.py create mode 100644 docker4bots/spn_python_base/spn_python_framework/src/main.py create mode 100644 docker4bots/spn_python_base/spn_python_framework/src/usercode.py diff --git a/docker4bots/spn_python_base/bot_wrapper.sh b/docker4bots/spn_python_base/bot_wrapper.sh index 486eae7..45892c5 100755 --- a/docker4bots/spn_python_base/bot_wrapper.sh +++ b/docker4bots/spn_python_base/bot_wrapper.sh @@ -10,6 +10,8 @@ case "$action" in cd /spnbot/spn_python_framework/ # copy template code into production container + cp -f src/api.py /spndata/ + cp -f src/main.py /spndata/ chmod +x /spndata/main.py ;; @@ -18,7 +20,7 @@ case "$action" in # run the bot and allow coredumps ulimit -c unlimited cd /spndata/ - ./usercode.py + ./main.py ;; doc) diff --git a/docker4bots/spn_python_base/spn_python_framework/src/api.py b/docker4bots/spn_python_base/spn_python_framework/src/api.py new file mode 100644 index 0000000..eb96971 --- /dev/null +++ b/docker4bots/spn_python_base/spn_python_framework/src/api.py @@ -0,0 +1,408 @@ +#!/usr/bin/env python3 + +import socket +import sys +import os +import struct +import mmap +import time +import math +import struct + +# | IpcSharedMemory offsets (shm) | +# | name | size | start offset | +# |-----------------|---------|----------------| +# | IpcServerConfig | 56 | 0 | +# | IpcSelfInfo | 44 | 56 | +# | foodCount | 4 | 100 | +# | IpcFoodInfo | 1048560 | 104 | +# | botCount | 4 | 1048664 | +# | IpcBotInfo | 73728 | 1048672 | +# | segmentCount | 4 | 1122400 | +# | IpcSegmentInfo | 1048560 | 1122408 | +# | colorCount | 4 | 2170968 | +# | IpcColor | 4096 | 2170972 | +# | logData | 1024 | 2175068 | +# | faceId | 4 | 2176092 | +# | dogTagId | 4 | 2176096 | +# | persistentData | 4096 | 2176100 | + +class Api(): + def __init__(self, shm): + self.shm_fd = shm + self.serverConfig = IpcServerConfig(self.shm_fd, 0) + self.selfInfo = IpcSelfInfo(self.shm_fd, 56) + self.food = IpcFoodInfo(self.shm_fd, 100) + self.bots = IpcBotInfo(self.shm_fd, 1048664) + self.segments = IpcSegmentInfo(self.shm_fd, 1122400) + self.colors = IpcColor(self.shm_fd, 2170968) + self.persMemory = IpcPersistentMemory(self.shm_fd, 2176100) + self.faceId = 0 + self.dogTagId = 0 + + def getServerConfig(self): + return self.serverConfig + + def getSelfInfo(self): + return self.selfInfo + + def getFood(self): + return self.food + + def getSegments(self): + return self.segments + + def getBots(self): + return self.bots + + def clearColors(self): + self.colors.clearColors() + + def addColor(self, r, g, b): + self.colors.addColor(r, g, b) + + def readPersistentMemory(self, offset, length): + return self.persMemory.read(offset, length) + + def writePersistentMemory(self, offset, data): + self.persMemory.write(offset, data) + + def log(self, message): + mem = mmap.mmap(self.shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_WRITE) + if len(message) >= 1024: + return + mem.seek(2175068) + mem.write(bytearray(message.encode("utf-8"))) + mem.write(bytes([0])) + + def setFaceId(self, id): + self.faceId = id + + def setDogTagId(self, id): + self.dogTagId = id + + + +class IpcServerConfig(): + def __init__(self, shm_fd, byteOffset): + self.mem = mmap.mmap(shm_fd, mmap.PAGESIZE, mmap.MAP_SHARED, mmap.PROT_READ) + self.offset = byteOffset + + def getSnakeBoostSteps(self): + """Number of steps a snake moves per frame while boosting""" + self.mem.seek(self.offset + 0*4) + return struct.unpack("I", self.mem.read(4))[0] + + def getSnakeTurnRadiusFactor(self): + """Multiplied with your segment radius to determine the inner turn radius""" + self.mem.seek(self.offset + 1*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getSnakePullFactor(self): + """Pull-together factor (determines how fast segments move to the center of a loop)""" + self.mem.seek(self.offset + 2*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getSnakeConversionFactor(self): + """how much of a snake's mass is converted to food when it dies""" + self.mem.seek(self.offset + 3*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getSnakeSegmentDistanceFactor(self): + """segment distance = (mass * factor)^exponent""" + self.mem.seek(self.offset + 4*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getSnakeSegmentDistanceExponent(self): + """segment distance = (mass * factor)^exponent""" + self.mem.seek(self.offset + 5*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getSnakeConsumeRange(self): + """consume range multiplier (multiplied with segment radius)""" + self.mem.seek(self.offset + 6*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getSnakeBoostLossFactor(self): + """Multiplied with the snakes mass to determine how much mass is lost per frame while boosting""" + self.mem.seek(self.offset + 7*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getSnakeSurvivalLossFactor(self): + """This part of your mass is dropped every frame (to limit snake growth)""" + self.mem.seek(self.offset + 8*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getSnakeSelfKillMassThreshold(self): + """Mass below which a snake dies through starvation""" + self.mem.seek(self.offset + 9*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getFoodDecayStep(self): + """Food decays by this value each frame""" + self.mem.seek(self.offset + 10*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getLogCreditsPerFrame(self): + """How many log messages you can send per frame""" + self.mem.seek(self.offset + 11*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getLogInitialCredits(self): + """How many log messages you can send right after startup""" + self.mem.seek(self.offset + 12*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getLogMaxCredits(self): + """You can send at most this many messages in a row""" + self.mem.seek(self.offset + 13*4) + return struct.unpack("f", self.mem.read(4))[0] + + + +class IpcSelfInfo(): + def __init__(self, shm_fd, byteOffset): + self.mem = mmap.mmap(shm_fd, mmap.PAGESIZE, mmap.MAP_SHARED, mmap.PROT_READ) + self.offset = byteOffset + + def getSegmentRadius(self): + """Radius of your snake's segments""" + self.mem.seek(self.offset + 0*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getMass(self): + """Your Snake's current mass""" + self.mem.seek(self.offset + 1*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getSightRadius(self): + """Radius around your snake's head in which you can see food and segments""" + self.mem.seek(self.offset + 2*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getConsumeRadius(self): + """Radius around your snake's head in which food is consumed""" + self.mem.seek(self.offset + 3*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getStartFrame(self): + """Frame number when your snake was spawned""" + self.mem.seek(self.offset + 4*4) + return struct.unpack("I", self.mem.read(4))[0] + + def getCurrentFrame(self): + """Current frame number""" + self.mem.seek(self.offset + 5*4) + return struct.unpack("I", self.mem.read(4))[0] + + def getSpeed(self): + """Distance per step""" + self.mem.seek(self.offset + 6*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getMaxStepAngle(self): + """Maximum direction change in this step""" + self.mem.seek(self.offset + 7*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getConsumedNaturalFood(self): + """Amount of "naturally" spawned food your snake consumed""" + self.mem.seek(self.offset + 8*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getConsumedFoodHuntedBySelf(self): + """Amount of food you consumed and that was created from snakes you killed""" + self.mem.seek(self.offset + 9*4) + return struct.unpack("f", self.mem.read(4))[0] + + def getConsumedFoodHuntedByOthers(self): + """Amount of food you consumed and that was created from snakes others killed (carrion)""" + self.mem.seek(self.offset + 10*4) + return struct.unpack("f", self.mem.read(4))[0] + + + +class IpcFoodInfo(): + ## Relative position X in world orientation + x = 0.0 + ## Relative position Y in world orientation + y = 0.0 + ## Food value + val = 0.0 + ## Direction angle relative to your heading (range -π to +π) + dir = 0.0 + ## Distance measured from the center of your head + dist = 0.0 + ## number of food elements to iterate over + elemCount = 0 + ## current element served by iterator + dataIdx = 0 + + def __init__(self, shm_fd, byteOffset): + self.mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_READ) + self.offset = byteOffset + self.mem.seek(self.offset) + self.elemCount = struct.unpack("I", self.mem.read(4))[0] + + def __len__(self): + """Get the length of the Food list""" + return self.elemCount + + def __iter__(self): + self.mem.seek(self.offset) + self.elemCount = struct.unpack("I", self.mem.read(4))[0] + self.dataIdx = 0 + return self + + def __next__(self): + """Get next Food list item""" + if self.dataIdx >= self.elemCount: + raise StopIteration + self.mem.seek(self.offset + 4 + (4*5 * self.dataIdx)) + self.x, self.y, self.val, self.dir, self.dist = struct.unpack("fffff", self.mem.read(5*4)) + self.dataIdx += 1 + return self + + + +class IpcBotInfo(): + ## Bot ID + botId = 0 + ## Bot name (the beginning of it, at least) + botName = "" + + def __init__(self, shm_fd, byteOffset): + self.mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_READ) + self.offset = byteOffset + self.mem.seek(self.offset) + self.elemCount = struct.unpack("I", self.mem.read(4))[0] + + def __len__(self): + """Get the length of the Bot list""" + return self.elemCount + + def __iter__(self): + self.mem.seek(self.offset) + self.elemCount = struct.unpack("I", self.mem.read(4))[0] + self.dataIdx = 0 + return self + + def __next__(self): + """Get next Bot list item""" + if self.dataIdx >= self.elemCount: + raise StopIteration + self.mem.seek(self.offset + 8 + ((8+64)*self.dataIdx)) + self.botId = struct.unpack("Q", self.mem.read(8))[0] + self.botName = str(self.mem.read(64).rstrip(b"\0").decode()) + self.dataIdx += 1 + return self + + + +class IpcSegmentInfo(): + ## Relative position X in world orientation + x = 0.0 + ## Relative position Y in world orientation + y = 0.0 + ## Segment radius + r = 0.0 + ## Direction angle relative to your heading (range -π to +π) + dir = 0.0 + ## Distance between the center of your head and the segment's center + dist = 0.0 + ## Segment number starting from head (idx == 0) + idx = 0 + ## Bot ID + botId = 0 + ## True if this segment belongs to ones own snake + isSelf = False + + def __init__(self, shm_fd, byteOffset): + self.mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_READ) + self.offset = byteOffset + self.mem.seek(self.offset) + self.elemCount = struct.unpack("I", self.mem.read(4))[0] + + def __len__(self): + return self.elemCount + + def __iter__(self): + self.mem.seek(self.offset) + self.elemCount = struct.unpack("I", self.mem.read(4))[0] + self.dataIdx = 0 + return self + + def __next__(self): + if self.dataIdx > self.elemCount: + raise StopIteration + self.mem.seek(self.offset + 8 + (40 * self.dataIdx)) + self.x, self.y, self.r, self.dir, self.dist, self.idx, self.botId, self.isSelf = struct.unpack("fffffIQ?xxx", self.mem.read(36)) + self.dataIdx += 1 + return self + + + +class IpcColor(): + ## Red channel (0-255) + r = 0 + ## Green channel (0-255) + g = 0 + ## Blue channel (0-255) + b = 0 + + def __init__(self, shm_fd, byteOffset): + self.mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_WRITE | mmap.PROT_READ) + self.offset = byteOffset + self.mem.seek(self.offset) + self.elemCount = 0 + + def __len__(self): + return self.elemCount + + def __iter__(self): + self.mem.seek(self.offset) + self.elemCount + self.dataIdx = 0 + return self + + def __next__(self): + if self.dataIdx > self.elemCount: + raise StopIteration + self.mem.seek(self.offset + 4 + (4 * self.dataIdx)) + self.r, self.g, self.b = struct.unpack("bbbx", self.mem.read(4)) + self.dataIdx += 1 + return self + + def addColor(self, r, g ,b): + if self.elemCount >= 1024: + return + + self.mem.seek(self.offset + 4 + (self.elemCount*4)) + self.mem.write(struct.pack("BBBx", int(r), int(g), int(b))) + self.elemCount += 1 + self.mem.seek(self.offset) + self.mem.write(struct.pack("I", self.elemCount)) + + def clearColors(self): + self.elemCount = 0 + self.mem.seek(self.offset) + self.mem.write(struct.pack("I", self.elemCount)) + + + +class IpcPersistentMemory(): + def __init__(self, shm_fd, byteOffset): + self.mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_WRITE | mmap.PROT_READ) + self.offset = byteOffset + + def read(self, offset, length): + if (offset + length) > 4096: + raise IndexError("reading past the buffer") + self.mem.seek(self.offset + offset) + return self.mem.read(length) + + def write(self, offset, data): + if (offset + len(data)) > 4096: + raise IndexError("writing past the buffer") + self.mem.seek(self.offset + offset) + self.mem.write(data) diff --git a/docker4bots/spn_python_base/spn_python_framework/src/main.py b/docker4bots/spn_python_base/spn_python_framework/src/main.py new file mode 100644 index 0000000..bd9b311 --- /dev/null +++ b/docker4bots/spn_python_base/spn_python_framework/src/main.py @@ -0,0 +1,55 @@ +#!/usr/bin/env python3 + +import sys +import os +import socket +import struct + +from api import Api +from usercode import init,step + +class SpnBot(): + RX_REQ_INIT=0 + RX_REQ_STEP=1 + socket = None + shm_fd = None + + def __init__(self): + self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET) + self.socket.connect("/spnshm/socket") + self.shm_fd = os.open("/spnshm/shm", os.O_RDWR) + self.api = Api(self.shm_fd) + + def __del__(self): + if self.socket: + self.socket.close() + if self.shm_fd: + os.close(self.shm_fd) + + def run(self): + angle = 0.0 + boost = False + success = False + + while True: + # wait for command from server + inData = self.socket.recv(4, 0) + + if len(inData) != 0: + request = struct.unpack("I", inData)[0] + else: + break # shutdown request from server + + if self.RX_REQ_STEP == request: + success, angle, boost = step(self.api) # call usercode + elif self.RX_REQ_INIT == request: + success = init(self.api) # call usercode + else: + pass # unknown command + + outData = struct.pack("Ifbxxx", int(not success), angle, boost) + self.socket.send(outData) + self.socket.close() + +main = SpnBot() +main.run() diff --git a/docker4bots/spn_python_base/spn_python_framework/src/usercode.py b/docker4bots/spn_python_base/spn_python_framework/src/usercode.py new file mode 100644 index 0000000..e69de29 From 54fa852885f2602113ede51b22c1152b6b5e3d9b Mon Sep 17 00:00:00 2001 From: Daniel Steuer Date: Sun, 5 Jun 2022 04:28:52 +0200 Subject: [PATCH 04/13] python container: run bot from /spnbot directory to minimize file movement The framework files are no longer moved into the /spndata directory This also means framework data is not backed up along with every usercode iteration --- docker4bots/spn_python_base/bot_wrapper.sh | 7 +------ .../spn_python_base/spn_python_framework/src/main.py | 3 ++- .../spn_python_base/spn_python_framework/src/usercode.py | 0 3 files changed, 3 insertions(+), 7 deletions(-) mode change 100644 => 100755 docker4bots/spn_python_base/spn_python_framework/src/main.py delete mode 100644 docker4bots/spn_python_base/spn_python_framework/src/usercode.py diff --git a/docker4bots/spn_python_base/bot_wrapper.sh b/docker4bots/spn_python_base/bot_wrapper.sh index 45892c5..3585fb1 100755 --- a/docker4bots/spn_python_base/bot_wrapper.sh +++ b/docker4bots/spn_python_base/bot_wrapper.sh @@ -9,17 +9,12 @@ case "$action" in # copy the code in, build and move the binary out cd /spnbot/spn_python_framework/ - # copy template code into production container - cp -f src/api.py /spndata/ - cp -f src/main.py /spndata/ - - chmod +x /spndata/main.py ;; run) # run the bot and allow coredumps ulimit -c unlimited - cd /spndata/ + cd /spnbot/spn_python_framework/src ./main.py ;; diff --git a/docker4bots/spn_python_base/spn_python_framework/src/main.py b/docker4bots/spn_python_base/spn_python_framework/src/main.py old mode 100644 new mode 100755 index bd9b311..43d8eef --- a/docker4bots/spn_python_base/spn_python_framework/src/main.py +++ b/docker4bots/spn_python_base/spn_python_framework/src/main.py @@ -5,8 +5,9 @@ import socket import struct -from api import Api +sys.path.insert(0, '/spndata') from usercode import init,step +from api import Api class SpnBot(): RX_REQ_INIT=0 diff --git a/docker4bots/spn_python_base/spn_python_framework/src/usercode.py b/docker4bots/spn_python_base/spn_python_framework/src/usercode.py deleted file mode 100644 index e69de29..0000000 From ee3732b4fea23fab9631b81b1423a0cd8dcabe1c Mon Sep 17 00:00:00 2001 From: Daniel Steuer Date: Sun, 5 Jun 2022 04:39:47 +0200 Subject: [PATCH 05/13] python container: run linter over usercode before startup --- docker4bots/spn_python_base/Dockerfile | 4 +- docker4bots/spn_python_base/bot_wrapper.sh | 2 + .../spn_python_framework/pylintrc | 600 ++++++++++++++++++ 3 files changed, 605 insertions(+), 1 deletion(-) create mode 100644 docker4bots/spn_python_base/spn_python_framework/pylintrc diff --git a/docker4bots/spn_python_base/Dockerfile b/docker4bots/spn_python_base/Dockerfile index 7eb3877..c4a6964 100644 --- a/docker4bots/spn_python_base/Dockerfile +++ b/docker4bots/spn_python_base/Dockerfile @@ -1,6 +1,8 @@ FROM alpine -RUN apk add --no-cache python3 py3-pip doxygen +RUN apk --no-cache add python3 py3-pip +RUN apk --no-cache add doxygen +RUN pip3 --no-cache-dir install pylint pylint-exit RUN addgroup -S spnbot && adduser --uid 1337 --home /spnbot -S spnbot --shell /bin/sh -G spnbot diff --git a/docker4bots/spn_python_base/bot_wrapper.sh b/docker4bots/spn_python_base/bot_wrapper.sh index 3585fb1..0f08bc0 100755 --- a/docker4bots/spn_python_base/bot_wrapper.sh +++ b/docker4bots/spn_python_base/bot_wrapper.sh @@ -9,6 +9,8 @@ case "$action" in # copy the code in, build and move the binary out cd /spnbot/spn_python_framework/ + echo "starting pylint" + pylint /spndata/usercode.py || pylint-exit $? ;; run) diff --git a/docker4bots/spn_python_base/spn_python_framework/pylintrc b/docker4bots/spn_python_base/spn_python_framework/pylintrc new file mode 100644 index 0000000..ee94663 --- /dev/null +++ b/docker4bots/spn_python_base/spn_python_framework/pylintrc @@ -0,0 +1,600 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold to be exceeded before program exits with error. +fail-under=10.0 + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the ignore-list. The +# regex matches against paths and can be in Posix or Windows format. +ignore-paths= + +# Files or directories matching the regex patterns are skipped. The regex +# matches against base names, not paths. The default value ignores emacs file +# locks +ignore-patterns=^\.# + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.10 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then re-enable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=C0303, # trailing whitespace + C0114, C0116, # missing docstring +# C0104 # disallowed names +# raw-checker-failed, +# bad-inline-option, +# locally-disabled, +# file-ignored, +# suppressed-message, +# useless-suppression, +# deprecated-pragma, +# use-symbolic-message-instead, +# max-statements + + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=50 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the 'python-enchant' package. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear and the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + + +[BASIC] + +# Naming style matching correct argument names. +#argument-naming-style=snake_case +argument-naming-style=any + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= + +# Naming style matching correct attribute names. +#attr-naming-style=snake_case +attr-naming-style=any + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +#class-const-naming-style=UPPER_CASE +class-const-naming-style=any + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= + +# Naming style matching correct class names. +#class-naming-style=PascalCase +class-naming-style=any + +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +#class-rgx= + +# Naming style matching correct constant names. +#const-naming-style=UPPER_CASE +const-naming-style=any + +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +#function-naming-style=snake_case +function-naming-style=any + +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= + +# Naming style matching correct method names. +#method-naming-style=snake_case +method-naming-style=any + +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= + +# Naming style matching correct module names. +#module-naming-style=snake_case +module-naming-style=any + +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= + +# Naming style matching correct variable names. +#variable-naming-style=snake_case +variable-naming-style=any + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# class is considered mixin if its name matches the mixin-class-rgx option. +ignore-mixin-members=yes + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# Regex pattern to define which classes are considered mixins ignore-mixin- +# members is set to 'yes' +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +#notes-rgx= + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=no + +# Signatures are removed from the similarity computation +ignore-signatures=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "BaseException, Exception". +overgeneral-exceptions=BaseException, + Exception + From 3f6c62574bed0aa510ecaa9eeb11c035560e3a07 Mon Sep 17 00:00:00 2001 From: Daniel Steuer Date: Sun, 5 Jun 2022 04:46:14 +0200 Subject: [PATCH 06/13] python container: main: add dockstrings and privatize members --- .../spn_python_framework/src/main.py | 48 ++++++++++--------- 1 file changed, 26 insertions(+), 22 deletions(-) diff --git a/docker4bots/spn_python_base/spn_python_framework/src/main.py b/docker4bots/spn_python_base/spn_python_framework/src/main.py index 43d8eef..f1a45bd 100755 --- a/docker4bots/spn_python_base/spn_python_framework/src/main.py +++ b/docker4bots/spn_python_base/spn_python_framework/src/main.py @@ -1,5 +1,7 @@ #!/usr/bin/env python3 +"""Main module providing the framework calling the bot code provided by the user""" + import sys import os import socket @@ -10,47 +12,49 @@ from api import Api class SpnBot(): + """Main class handling communication with the gameserver and calling bot code provided by the user""" RX_REQ_INIT=0 RX_REQ_STEP=1 - socket = None - shm_fd = None + __socket = None + __shm_fd = None def __init__(self): - self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET) - self.socket.connect("/spnshm/socket") - self.shm_fd = os.open("/spnshm/shm", os.O_RDWR) - self.api = Api(self.shm_fd) + self.__socket = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET) + self.__socket.connect("/spnshm/socket") + self.__shm_fd = os.open("/spnshm/shm", os.O_RDWR) + self.__api = Api(self.__shm_fd) def __del__(self): - if self.socket: - self.socket.close() - if self.shm_fd: - os.close(self.shm_fd) + if self.__socket: + self.__socket.close() + if self.__shm_fd: + os.close(self.__shm_fd) def run(self): + """main event loop""" angle = 0.0 boost = False success = False while True: # wait for command from server - inData = self.socket.recv(4, 0) + in_data = self.__socket.recv(4, 0) - if len(inData) != 0: - request = struct.unpack("I", inData)[0] + if len(in_data) != 0: + request = struct.unpack("I", in_data)[0] else: break # shutdown request from server - if self.RX_REQ_STEP == request: - success, angle, boost = step(self.api) # call usercode - elif self.RX_REQ_INIT == request: - success = init(self.api) # call usercode - else: - pass # unknown command + if self.RX_REQ_STEP == request: + success, angle, boost = step(self.__api) # call usercode + elif self.RX_REQ_INIT == request: + success = init(self.__api) # call usercode + else: + pass # unknown command - outData = struct.pack("Ifbxxx", int(not success), angle, boost) - self.socket.send(outData) - self.socket.close() + out_data = struct.pack("Ifbxxx", int(not success), angle, boost) + self.__socket.send(out_data) + self.__socket.close() main = SpnBot() main.run() From 1f7a9f0289bbb6a04fa7b79f2ee9726f6d509d6a Mon Sep 17 00:00:00 2001 From: Daniel Steuer Date: Sun, 5 Jun 2022 04:51:16 +0200 Subject: [PATCH 07/13] python container: main: catch all usercode exceptions and print to web console --- docker4bots/spn_python_base/spn_python_framework/src/main.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docker4bots/spn_python_base/spn_python_framework/src/main.py b/docker4bots/spn_python_base/spn_python_framework/src/main.py index f1a45bd..7f2124b 100755 --- a/docker4bots/spn_python_base/spn_python_framework/src/main.py +++ b/docker4bots/spn_python_base/spn_python_framework/src/main.py @@ -3,6 +3,7 @@ """Main module providing the framework calling the bot code provided by the user""" import sys +import traceback import os import socket import struct @@ -45,12 +46,16 @@ def run(self): else: break # shutdown request from server + try: if self.RX_REQ_STEP == request: success, angle, boost = step(self.__api) # call usercode elif self.RX_REQ_INIT == request: success = init(self.__api) # call usercode else: pass # unknown command + except Exception: + self.__api.log(traceback.format_exc(limit=-4)) # only print line the exception occured on + success = False # kill bot out_data = struct.pack("Ifbxxx", int(not success), angle, boost) self.__socket.send(out_data) From 4088ac1e54110228354940a5e855b4f8a6d5e5f4 Mon Sep 17 00:00:00 2001 From: Daniel Steuer Date: Sun, 5 Jun 2022 05:11:15 +0200 Subject: [PATCH 08/13] python container: api: add dockstrings and privatize members. Remove unused imports --- .../spn_python_framework/src/api.py | 410 ++++++++++-------- 1 file changed, 221 insertions(+), 189 deletions(-) diff --git a/docker4bots/spn_python_base/spn_python_framework/src/api.py b/docker4bots/spn_python_base/spn_python_framework/src/api.py index eb96971..0c3ced0 100644 --- a/docker4bots/spn_python_base/spn_python_framework/src/api.py +++ b/docker4bots/spn_python_base/spn_python_framework/src/api.py @@ -1,13 +1,9 @@ #!/usr/bin/env python3 -import socket -import sys -import os +"""The python API for bots written for the SchlangenProgrammierNacht""" + import struct import mmap -import time -import math -import struct # | IpcSharedMemory offsets (shm) | # | name | size | start offset | @@ -27,202 +23,206 @@ # | dogTagId | 4 | 2176096 | # | persistentData | 4096 | 2176100 | -class Api(): - def __init__(self, shm): - self.shm_fd = shm - self.serverConfig = IpcServerConfig(self.shm_fd, 0) - self.selfInfo = IpcSelfInfo(self.shm_fd, 56) - self.food = IpcFoodInfo(self.shm_fd, 100) - self.bots = IpcBotInfo(self.shm_fd, 1048664) - self.segments = IpcSegmentInfo(self.shm_fd, 1122400) - self.colors = IpcColor(self.shm_fd, 2170968) - self.persMemory = IpcPersistentMemory(self.shm_fd, 2176100) - self.faceId = 0 - self.dogTagId = 0 - - def getServerConfig(self): - return self.serverConfig - - def getSelfInfo(self): - return self.selfInfo - - def getFood(self): - return self.food - - def getSegments(self): - return self.segments - def getBots(self): - return self.bots - - def clearColors(self): - self.colors.clearColors() - - def addColor(self, r, g, b): - self.colors.addColor(r, g, b) +class Api(): + """ + Top level data class exposing configuration and some actions to bots + """ - def readPersistentMemory(self, offset, length): - return self.persMemory.read(offset, length) + face_id = 0 + dog_tag_id = 0 - def writePersistentMemory(self, offset, data): - self.persMemory.write(offset, data) + def __init__(self, shm): + self.__shm_fd = shm + self.server_config = IpcServerConfig(self.__shm_fd, 0) + self.self_info = IpcSelfInfo(self.__shm_fd, 56) + self.food = IpcFoodInfo(self.__shm_fd, 100) + self.bots = IpcBotInfo(self.__shm_fd, 1048664) + self.segments = IpcSegmentInfo(self.__shm_fd, 1122400) + self.__colors = IpcColor(self.__shm_fd, 2170968) + self.__pers_memory = IpcPersistentMemory(self.__shm_fd, 2176100) + + def clear_colors(self): + """reset the color pattern of the bot""" + self.__colors.clear_colors() + + def add_color(self, red, green, blue): + """add a color to the color sequence marking the bot""" + self.__colors.add_color(red, green, blue) + + def read_persistent_memory(self, offset, length): + """read from only memory section that is persistent even over bot restarts""" + return self.__pers_memory.read(offset, length) + + def write_persistent_memory(self, offset, data): + """write to only memory section that is persistent even over bot restarts""" + self.__pers_memory.write(offset, data) def log(self, message): - mem = mmap.mmap(self.shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_WRITE) - if len(message) >= 1024: - return - mem.seek(2175068) - mem.write(bytearray(message.encode("utf-8"))) - mem.write(bytes([0])) - - def setFaceId(self, id): - self.faceId = id - - def setDogTagId(self, id): - self.dogTagId = id + """write a log message to the console""" + message_str = str(message) + mem = mmap.mmap(self.__shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_WRITE) + if len(message_str) < 1024: + mem.seek(2175068) + mem.write(bytearray(message_str.encode("utf-8"))) + mem.write(bytes([0])) class IpcServerConfig(): - def __init__(self, shm_fd, byteOffset): - self.mem = mmap.mmap(shm_fd, mmap.PAGESIZE, mmap.MAP_SHARED, mmap.PROT_READ) - self.offset = byteOffset + """ + Data class exposing the game server configuration to bots + """ + + def __init__(self, shm_fd, byte_offset): + self.__mem = mmap.mmap(shm_fd, mmap.PAGESIZE, mmap.MAP_SHARED, mmap.PROT_READ) + self.__offset = byte_offset def getSnakeBoostSteps(self): """Number of steps a snake moves per frame while boosting""" - self.mem.seek(self.offset + 0*4) - return struct.unpack("I", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 0*4) + return struct.unpack("I", self.__mem.read(4))[0] def getSnakeTurnRadiusFactor(self): """Multiplied with your segment radius to determine the inner turn radius""" - self.mem.seek(self.offset + 1*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 1*4) + return struct.unpack("f", self.__mem.read(4))[0] def getSnakePullFactor(self): """Pull-together factor (determines how fast segments move to the center of a loop)""" - self.mem.seek(self.offset + 2*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 2*4) + return struct.unpack("f", self.__mem.read(4))[0] def getSnakeConversionFactor(self): """how much of a snake's mass is converted to food when it dies""" - self.mem.seek(self.offset + 3*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 3*4) + return struct.unpack("f", self.__mem.read(4))[0] def getSnakeSegmentDistanceFactor(self): """segment distance = (mass * factor)^exponent""" - self.mem.seek(self.offset + 4*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 4*4) + return struct.unpack("f", self.__mem.read(4))[0] def getSnakeSegmentDistanceExponent(self): """segment distance = (mass * factor)^exponent""" - self.mem.seek(self.offset + 5*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 5*4) + return struct.unpack("f", self.__mem.read(4))[0] def getSnakeConsumeRange(self): """consume range multiplier (multiplied with segment radius)""" - self.mem.seek(self.offset + 6*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 6*4) + return struct.unpack("f", self.__mem.read(4))[0] def getSnakeBoostLossFactor(self): """Multiplied with the snakes mass to determine how much mass is lost per frame while boosting""" - self.mem.seek(self.offset + 7*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 7*4) + return struct.unpack("f", self.__mem.read(4))[0] def getSnakeSurvivalLossFactor(self): """This part of your mass is dropped every frame (to limit snake growth)""" - self.mem.seek(self.offset + 8*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 8*4) + return struct.unpack("f", self.__mem.read(4))[0] def getSnakeSelfKillMassThreshold(self): """Mass below which a snake dies through starvation""" - self.mem.seek(self.offset + 9*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 9*4) + return struct.unpack("f", self.__mem.read(4))[0] def getFoodDecayStep(self): """Food decays by this value each frame""" - self.mem.seek(self.offset + 10*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 10*4) + return struct.unpack("f", self.__mem.read(4))[0] def getLogCreditsPerFrame(self): """How many log messages you can send per frame""" - self.mem.seek(self.offset + 11*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 11*4) + return struct.unpack("f", self.__mem.read(4))[0] def getLogInitialCredits(self): """How many log messages you can send right after startup""" - self.mem.seek(self.offset + 12*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 12*4) + return struct.unpack("f", self.__mem.read(4))[0] def getLogMaxCredits(self): """You can send at most this many messages in a row""" - self.mem.seek(self.offset + 13*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 13*4) + return struct.unpack("f", self.__mem.read(4))[0] + + class IpcSelfInfo(): - def __init__(self, shm_fd, byteOffset): - self.mem = mmap.mmap(shm_fd, mmap.PAGESIZE, mmap.MAP_SHARED, mmap.PROT_READ) - self.offset = byteOffset + """ + Data class exposing general information about this bot + """ + + def __init__(self, shm_fd, byte_offset): + self.__mem = mmap.mmap(shm_fd, mmap.PAGESIZE, mmap.MAP_SHARED, mmap.PROT_READ) + self.__offset = byte_offset def getSegmentRadius(self): """Radius of your snake's segments""" - self.mem.seek(self.offset + 0*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 0*4) + return struct.unpack("f", self.__mem.read(4))[0] def getMass(self): """Your Snake's current mass""" - self.mem.seek(self.offset + 1*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 1*4) + return struct.unpack("f", self.__mem.read(4))[0] def getSightRadius(self): """Radius around your snake's head in which you can see food and segments""" - self.mem.seek(self.offset + 2*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 2*4) + return struct.unpack("f", self.__mem.read(4))[0] def getConsumeRadius(self): """Radius around your snake's head in which food is consumed""" - self.mem.seek(self.offset + 3*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 3*4) + return struct.unpack("f", self.__mem.read(4))[0] def getStartFrame(self): """Frame number when your snake was spawned""" - self.mem.seek(self.offset + 4*4) - return struct.unpack("I", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 4*4) + return struct.unpack("I", self.__mem.read(4))[0] def getCurrentFrame(self): """Current frame number""" - self.mem.seek(self.offset + 5*4) - return struct.unpack("I", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 5*4) + return struct.unpack("I", self.__mem.read(4))[0] def getSpeed(self): """Distance per step""" - self.mem.seek(self.offset + 6*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 6*4) + return struct.unpack("f", self.__mem.read(4))[0] def getMaxStepAngle(self): """Maximum direction change in this step""" - self.mem.seek(self.offset + 7*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 7*4) + return struct.unpack("f", self.__mem.read(4))[0] def getConsumedNaturalFood(self): """Amount of "naturally" spawned food your snake consumed""" - self.mem.seek(self.offset + 8*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 8*4) + return struct.unpack("f", self.__mem.read(4))[0] def getConsumedFoodHuntedBySelf(self): """Amount of food you consumed and that was created from snakes you killed""" - self.mem.seek(self.offset + 9*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 9*4) + return struct.unpack("f", self.__mem.read(4))[0] def getConsumedFoodHuntedByOthers(self): """Amount of food you consumed and that was created from snakes others killed (carrion)""" - self.mem.seek(self.offset + 10*4) - return struct.unpack("f", self.mem.read(4))[0] + self.__mem.seek(self.__offset + 10*4) + return struct.unpack("f", self.__mem.read(4))[0] class IpcFoodInfo(): + """ + Data class exposing information about size and location of food objects + """ + ## Relative position X in world orientation x = 0.0 ## Relative position Y in world orientation @@ -234,72 +234,82 @@ class IpcFoodInfo(): ## Distance measured from the center of your head dist = 0.0 ## number of food elements to iterate over - elemCount = 0 + elem_count = 0 ## current element served by iterator - dataIdx = 0 + __data_idx = 0 - def __init__(self, shm_fd, byteOffset): - self.mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_READ) - self.offset = byteOffset - self.mem.seek(self.offset) - self.elemCount = struct.unpack("I", self.mem.read(4))[0] + def __init__(self, shm_fd, byte_offset): + self.__mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_READ) + self.__offset = byte_offset + self.__mem.seek(self.__offset) + self.__elem_count = struct.unpack("I", self.__mem.read(4))[0] def __len__(self): """Get the length of the Food list""" - return self.elemCount + return self.__elem_count def __iter__(self): - self.mem.seek(self.offset) - self.elemCount = struct.unpack("I", self.mem.read(4))[0] - self.dataIdx = 0 + self.__mem.seek(self.__offset) + self.__elem_count = struct.unpack("I", self.__mem.read(4))[0] + self.__data_idx = 0 return self def __next__(self): """Get next Food list item""" - if self.dataIdx >= self.elemCount: + if self.__data_idx >= self.__elem_count: raise StopIteration - self.mem.seek(self.offset + 4 + (4*5 * self.dataIdx)) - self.x, self.y, self.val, self.dir, self.dist = struct.unpack("fffff", self.mem.read(5*4)) - self.dataIdx += 1 + self.__mem.seek(self.__offset + 4 + (4*5 * self.__data_idx)) + self.x, self.y, self.val, self.dir, self.dist = struct.unpack("fffff", self.__mem.read(5*4)) + self.__data_idx += 1 return self class IpcBotInfo(): + """ + Data class exposing a mapping of bot_ids to bot names in the bots range of vision + """ + ## Bot ID - botId = 0 + bot_id = 0 ## Bot name (the beginning of it, at least) - botName = "" + bot_name = "" + ## current element served by iterator + __data_idx = 0 - def __init__(self, shm_fd, byteOffset): - self.mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_READ) - self.offset = byteOffset - self.mem.seek(self.offset) - self.elemCount = struct.unpack("I", self.mem.read(4))[0] + def __init__(self, shm_fd, byte_offset): + self.__mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_READ) + self.__offset = byte_offset + self.__mem.seek(self.__offset) + self.__elem_count = struct.unpack("I", self.__mem.read(4))[0] def __len__(self): """Get the length of the Bot list""" - return self.elemCount + return self.__elem_count def __iter__(self): - self.mem.seek(self.offset) - self.elemCount = struct.unpack("I", self.mem.read(4))[0] - self.dataIdx = 0 + self.__mem.seek(self.__offset) + self.__elem_count = struct.unpack("I", self.__mem.read(4))[0] + self.__data_idx = 0 return self def __next__(self): """Get next Bot list item""" - if self.dataIdx >= self.elemCount: + if self.__data_idx >= self.__elem_count: raise StopIteration - self.mem.seek(self.offset + 8 + ((8+64)*self.dataIdx)) - self.botId = struct.unpack("Q", self.mem.read(8))[0] - self.botName = str(self.mem.read(64).rstrip(b"\0").decode()) - self.dataIdx += 1 + self.__mem.seek(self.__offset + 8 + ((8+64) * self.__data_idx)) + self.bot_id = struct.unpack("Q", self.__mem.read(8))[0] + self.bot_name = str(self.__mem.read(64).rstrip(b"\0").decode()) + self.__data_idx += 1 return self class IpcSegmentInfo(): + """ + Data class exposing information about size and location of other bots in the range of vision of this bot + """ + ## Relative position X in world orientation x = 0.0 ## Relative position Y in world orientation @@ -313,96 +323,118 @@ class IpcSegmentInfo(): ## Segment number starting from head (idx == 0) idx = 0 ## Bot ID - botId = 0 + bot_id = 0 ## True if this segment belongs to ones own snake - isSelf = False + is_self = False + ## current element served by iterator + __data_idx = 0 - def __init__(self, shm_fd, byteOffset): - self.mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_READ) - self.offset = byteOffset - self.mem.seek(self.offset) - self.elemCount = struct.unpack("I", self.mem.read(4))[0] + def __init__(self, shm_fd, byte_offset): + self.__mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_READ) + self.__offset = byte_offset + self.__mem.seek(self.__offset) + self.__elem_count = struct.unpack("I", self.__mem.read(4))[0] def __len__(self): - return self.elemCount + """Get the length of the Segment list""" + return self.__elem_count def __iter__(self): - self.mem.seek(self.offset) - self.elemCount = struct.unpack("I", self.mem.read(4))[0] - self.dataIdx = 0 + """Get next Bot list item""" + self.__mem.seek(self.__offset) + self.__elem_count = struct.unpack("I", self.__mem.read(4))[0] + self.__data_idx = 0 return self def __next__(self): - if self.dataIdx > self.elemCount: + """Get next Bot list item""" + if self.__data_idx > self.__elem_count: raise StopIteration - self.mem.seek(self.offset + 8 + (40 * self.dataIdx)) - self.x, self.y, self.r, self.dir, self.dist, self.idx, self.botId, self.isSelf = struct.unpack("fffffIQ?xxx", self.mem.read(36)) - self.dataIdx += 1 + self.__mem.seek(self.__offset + 8 + (40 * self.__data_idx)) + self.x, self.y, self.r, self.dir, self.dist, self.idx, self.bot_id, self.is_self = struct.unpack("fffffIQ?xxx", self.__mem.read(36)) + self.__data_idx += 1 return self class IpcColor(): + """ + Data class exposing information about the color pattern of this bot + """ + ## Red channel (0-255) r = 0 ## Green channel (0-255) g = 0 ## Blue channel (0-255) b = 0 + ## current element served by iterator + __data_idx = 0 + + def __init__(self, shm_fd, byte_offset): + self.__mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_WRITE | mmap.PROT_READ) + self.__offset = byte_offset + self.__mem.seek(self.__offset) + self.__elem_count = struct.unpack("I", self.__mem.read(4))[0] - def __init__(self, shm_fd, byteOffset): - self.mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_WRITE | mmap.PROT_READ) - self.offset = byteOffset - self.mem.seek(self.offset) - self.elemCount = 0 def __len__(self): - return self.elemCount + """Get the length of the Color list""" + return self.__elem_count def __iter__(self): - self.mem.seek(self.offset) - self.elemCount - self.dataIdx = 0 + self.__mem.seek(self.__offset) + self.__elem_count = struct.unpack("I", self.__mem.read(4))[0] + self.__data_idx = 0 return self def __next__(self): - if self.dataIdx > self.elemCount: + """Get next Color list item""" + if self.__data_idx > self.__elem_count: raise StopIteration - self.mem.seek(self.offset + 4 + (4 * self.dataIdx)) - self.r, self.g, self.b = struct.unpack("bbbx", self.mem.read(4)) - self.dataIdx += 1 + self.__mem.seek(self.__offset + 4 + (4 * self.__data_idx)) + self.r, self.g, self.b = struct.unpack("BBBx", self.__mem.read(4)) + self.__data_idx += 1 return self - def addColor(self, r, g ,b): - if self.elemCount >= 1024: + def add_color(self, r, g ,b): + """add a color to the color sequence marking the bot""" + if self.__elem_count >= 1024: return - self.mem.seek(self.offset + 4 + (self.elemCount*4)) - self.mem.write(struct.pack("BBBx", int(r), int(g), int(b))) - self.elemCount += 1 - self.mem.seek(self.offset) - self.mem.write(struct.pack("I", self.elemCount)) + self.__mem.seek(self.__offset + 4 + (self.__elem_count * 4)) + self.__mem.write(struct.pack("BBBx", int(r), int(g), int(b))) + self.__elem_count += 1 + self.__mem.seek(self.__offset) + self.__mem.write(struct.pack("I", self.__elem_count)) - def clearColors(self): - self.elemCount = 0 - self.mem.seek(self.offset) - self.mem.write(struct.pack("I", self.elemCount)) + def clear_colors(self): + """reset the color pattern of the bot""" + self.__elem_count = 0 + self.__mem.seek(self.__offset) + self.__mem.write(struct.pack("I", self.__elem_count)) class IpcPersistentMemory(): - def __init__(self, shm_fd, byteOffset): - self.mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_WRITE | mmap.PROT_READ) - self.offset = byteOffset + """ + Provides an interface to persistant memory to this bot + """ + + def __init__(self, shm_fd, byte_offset): + self.__mem = mmap.mmap(shm_fd, 0, mmap.MAP_SHARED, mmap.PROT_WRITE | mmap.PROT_READ) + self.__offset = byte_offset def read(self, offset, length): + """read from only memory section that is persistent even over bot restarts""" if (offset + length) > 4096: - raise IndexError("reading past the buffer") - self.mem.seek(self.offset + offset) - return self.mem.read(length) + raise IndexError(f"offset({offset}) + length({length}) > 4096. reading past the buffer") + self.__mem.seek(self.__offset + offset) + return self.__mem.read(length) def write(self, offset, data): + """write to only memory section that is persistent even over bot restarts""" if (offset + len(data)) > 4096: - raise IndexError("writing past the buffer") - self.mem.seek(self.offset + offset) - self.mem.write(data) + raise IndexError(f"offset({offset}) + length({len(data)}) > 4096. writing past the buffer") + self.__mem.seek(self.__offset + offset) + self.__mem.write(data) From b7fce4a1d4945064fa10384f0149bcc3e4f30dfa Mon Sep 17 00:00:00 2001 From: Daniel Steuer Date: Sun, 5 Jun 2022 05:13:32 +0200 Subject: [PATCH 09/13] python container: api: use property decorator to get rid of getter method syntax --- .../spn_python_framework/src/api.py | 75 ++++++++++++------- 1 file changed, 50 insertions(+), 25 deletions(-) diff --git a/docker4bots/spn_python_base/spn_python_framework/src/api.py b/docker4bots/spn_python_base/spn_python_framework/src/api.py index 0c3ced0..08f5f07 100644 --- a/docker4bots/spn_python_base/spn_python_framework/src/api.py +++ b/docker4bots/spn_python_base/spn_python_framework/src/api.py @@ -78,72 +78,86 @@ def __init__(self, shm_fd, byte_offset): self.__mem = mmap.mmap(shm_fd, mmap.PAGESIZE, mmap.MAP_SHARED, mmap.PROT_READ) self.__offset = byte_offset - def getSnakeBoostSteps(self): + @property + def snake_boost_steps(self): """Number of steps a snake moves per frame while boosting""" self.__mem.seek(self.__offset + 0*4) return struct.unpack("I", self.__mem.read(4))[0] - def getSnakeTurnRadiusFactor(self): + @property + def snake_turn_radius_factor(self): """Multiplied with your segment radius to determine the inner turn radius""" self.__mem.seek(self.__offset + 1*4) return struct.unpack("f", self.__mem.read(4))[0] - def getSnakePullFactor(self): + @property + def snake_pull_factor(self): """Pull-together factor (determines how fast segments move to the center of a loop)""" self.__mem.seek(self.__offset + 2*4) return struct.unpack("f", self.__mem.read(4))[0] - def getSnakeConversionFactor(self): + @property + def snake_conversion_factor(self): """how much of a snake's mass is converted to food when it dies""" self.__mem.seek(self.__offset + 3*4) return struct.unpack("f", self.__mem.read(4))[0] - def getSnakeSegmentDistanceFactor(self): + @property + def snake_segment_distance_factor(self): """segment distance = (mass * factor)^exponent""" self.__mem.seek(self.__offset + 4*4) return struct.unpack("f", self.__mem.read(4))[0] - def getSnakeSegmentDistanceExponent(self): + @property + def snake_segment_distance_exponent(self): """segment distance = (mass * factor)^exponent""" self.__mem.seek(self.__offset + 5*4) return struct.unpack("f", self.__mem.read(4))[0] - def getSnakeConsumeRange(self): + @property + def snake_consume_range(self): """consume range multiplier (multiplied with segment radius)""" self.__mem.seek(self.__offset + 6*4) return struct.unpack("f", self.__mem.read(4))[0] - def getSnakeBoostLossFactor(self): + @property + def snake_boost_loss_factor(self): """Multiplied with the snakes mass to determine how much mass is lost per frame while boosting""" self.__mem.seek(self.__offset + 7*4) return struct.unpack("f", self.__mem.read(4))[0] - def getSnakeSurvivalLossFactor(self): + @property + def snake_survival_loss_factor(self): """This part of your mass is dropped every frame (to limit snake growth)""" self.__mem.seek(self.__offset + 8*4) return struct.unpack("f", self.__mem.read(4))[0] - def getSnakeSelfKillMassThreshold(self): + @property + def snake_self_kill_mass_threshold(self): """Mass below which a snake dies through starvation""" self.__mem.seek(self.__offset + 9*4) return struct.unpack("f", self.__mem.read(4))[0] - def getFoodDecayStep(self): + @property + def food_decay_step(self): """Food decays by this value each frame""" self.__mem.seek(self.__offset + 10*4) return struct.unpack("f", self.__mem.read(4))[0] - def getLogCreditsPerFrame(self): + @property + def log_credits_per_frame(self): """How many log messages you can send per frame""" self.__mem.seek(self.__offset + 11*4) return struct.unpack("f", self.__mem.read(4))[0] - def getLogInitialCredits(self): + @property + def log_initial_credits(self): """How many log messages you can send right after startup""" self.__mem.seek(self.__offset + 12*4) return struct.unpack("f", self.__mem.read(4))[0] - def getLogMaxCredits(self): + @property + def log_max_credits(self): """You can send at most this many messages in a row""" self.__mem.seek(self.__offset + 13*4) return struct.unpack("f", self.__mem.read(4))[0] @@ -161,57 +175,68 @@ def __init__(self, shm_fd, byte_offset): self.__mem = mmap.mmap(shm_fd, mmap.PAGESIZE, mmap.MAP_SHARED, mmap.PROT_READ) self.__offset = byte_offset - def getSegmentRadius(self): + @property + def segment_radius(self): """Radius of your snake's segments""" self.__mem.seek(self.__offset + 0*4) return struct.unpack("f", self.__mem.read(4))[0] - def getMass(self): + @property + def mass(self): """Your Snake's current mass""" self.__mem.seek(self.__offset + 1*4) return struct.unpack("f", self.__mem.read(4))[0] - def getSightRadius(self): + @property + def sight_radius(self): """Radius around your snake's head in which you can see food and segments""" self.__mem.seek(self.__offset + 2*4) return struct.unpack("f", self.__mem.read(4))[0] - def getConsumeRadius(self): + @property + def consume_radius(self): """Radius around your snake's head in which food is consumed""" self.__mem.seek(self.__offset + 3*4) return struct.unpack("f", self.__mem.read(4))[0] - def getStartFrame(self): + @property + def start_frame(self): """Frame number when your snake was spawned""" self.__mem.seek(self.__offset + 4*4) return struct.unpack("I", self.__mem.read(4))[0] - def getCurrentFrame(self): + @property + def current_frame(self): """Current frame number""" self.__mem.seek(self.__offset + 5*4) return struct.unpack("I", self.__mem.read(4))[0] - def getSpeed(self): + @property + def speed(self): """Distance per step""" self.__mem.seek(self.__offset + 6*4) return struct.unpack("f", self.__mem.read(4))[0] - def getMaxStepAngle(self): + @property + def max_step_angle(self): """Maximum direction change in this step""" self.__mem.seek(self.__offset + 7*4) return struct.unpack("f", self.__mem.read(4))[0] - def getConsumedNaturalFood(self): + @property + def consumed_natural_food(self): """Amount of "naturally" spawned food your snake consumed""" self.__mem.seek(self.__offset + 8*4) return struct.unpack("f", self.__mem.read(4))[0] - def getConsumedFoodHuntedBySelf(self): + @property + def consumed_food_hunted_by_self(self): """Amount of food you consumed and that was created from snakes you killed""" self.__mem.seek(self.__offset + 9*4) return struct.unpack("f", self.__mem.read(4))[0] - def getConsumedFoodHuntedByOthers(self): + @property + def consumed_food_hunted_by_others(self): """Amount of food you consumed and that was created from snakes others killed (carrion)""" self.__mem.seek(self.__offset + 10*4) return struct.unpack("f", self.__mem.read(4))[0] From 0f0df4b771a073e4a29c4a210040d6246fb3cbfa Mon Sep 17 00:00:00 2001 From: Daniel Steuer Date: Sun, 5 Jun 2022 05:16:33 +0200 Subject: [PATCH 10/13] python container: api: iterators are now also indexable --- .../spn_python_framework/src/api.py | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/docker4bots/spn_python_base/spn_python_framework/src/api.py b/docker4bots/spn_python_base/spn_python_framework/src/api.py index 08f5f07..29921f8 100644 --- a/docker4bots/spn_python_base/spn_python_framework/src/api.py +++ b/docker4bots/spn_python_base/spn_python_framework/src/api.py @@ -288,6 +288,13 @@ def __next__(self): self.__data_idx += 1 return self + def __getitem__(self, idx): + """get element at index but don't affect iteration""" + if idx >= self.__elem_count: + raise IndexError + self.__mem.seek(self.__offset + 4 + (4*5 * idx)) + self.x, self.y, self.val, self.dir, self.dist = struct.unpack("fffff", self.__mem.read(5*4)) + return self class IpcBotInfo(): @@ -328,6 +335,14 @@ def __next__(self): self.__data_idx += 1 return self + def __getitem__(self, idx): + """get element at index but don't affect iteration""" + if idx >= self.__elem_count: + raise IndexError + self.__mem.seek(self.__offset + 8 + ((8+64) * idx)) + self.bot_id = struct.unpack("Q", self.__mem.read(8))[0] + self.bot_name = str(self.__mem.read(64).rstrip(b"\0").decode()) + return self class IpcSegmentInfo(): @@ -380,6 +395,13 @@ def __next__(self): self.__data_idx += 1 return self + def __getitem__(self, idx): + """get element at index but don't affect iteration""" + if idx >= self.__elem_count: + raise IndexError(f"idx({idx}) >= elem_count({self.__elem_count})") + self.__mem.seek(self.__offset + 8 + (40 * self.idx)) + self.x, self.y, self.r, self.dir, self.dist, self.idx, self.bot_id, self.is_self = struct.unpack("fffffIQ?xxx", self.__mem.read(36)) + return self class IpcColor(): @@ -422,6 +444,15 @@ def __next__(self): self.__data_idx += 1 return self + def __getitem__(self, idx): + """get element at index but don't affect iteration""" + if idx >= self.__elem_count: + raise IndexError(f"idx({idx}) >= elem_count({self.__elem_count})") + + self.__mem.seek(self.__offset + 4 + (4 * idx)) + self.r, self.g, self.b = struct.unpack("BBBx", self.__mem.read(4)) + return self + def add_color(self, r, g ,b): """add a color to the color sequence marking the bot""" if self.__elem_count >= 1024: From be63eb623e98679891875418af4afcb47c07e055 Mon Sep 17 00:00:00 2001 From: Daniel Steuer Date: Sun, 5 Jun 2022 05:17:16 +0200 Subject: [PATCH 11/13] python container: make numpy module available for bots --- docker4bots/spn_python_base/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker4bots/spn_python_base/Dockerfile b/docker4bots/spn_python_base/Dockerfile index c4a6964..8f7eab9 100644 --- a/docker4bots/spn_python_base/Dockerfile +++ b/docker4bots/spn_python_base/Dockerfile @@ -1,6 +1,6 @@ FROM alpine -RUN apk --no-cache add python3 py3-pip +RUN apk --no-cache add python3 py3-pip py3-numpy RUN apk --no-cache add doxygen RUN pip3 --no-cache-dir install pylint pylint-exit From 57d1d169cb23a3d02186b07d5fae4f604b91af12 Mon Sep 17 00:00:00 2001 From: Thomas Kolb Date: Fri, 16 Dec 2022 21:34:11 +0100 Subject: [PATCH 12/13] python framework: fixed off-by-one in IpcSegmentInfo --- docker4bots/spn_python_base/spn_python_framework/src/api.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker4bots/spn_python_base/spn_python_framework/src/api.py b/docker4bots/spn_python_base/spn_python_framework/src/api.py index 29921f8..78d9926 100644 --- a/docker4bots/spn_python_base/spn_python_framework/src/api.py +++ b/docker4bots/spn_python_base/spn_python_framework/src/api.py @@ -388,7 +388,7 @@ def __iter__(self): def __next__(self): """Get next Bot list item""" - if self.__data_idx > self.__elem_count: + if self.__data_idx >= self.__elem_count: raise StopIteration self.__mem.seek(self.__offset + 8 + (40 * self.__data_idx)) self.x, self.y, self.r, self.dir, self.dist, self.idx, self.bot_id, self.is_self = struct.unpack("fffffIQ?xxx", self.__mem.read(36)) From 492745554624f70614a47661cc02d9f79cdb0472 Mon Sep 17 00:00:00 2001 From: Thomas Kolb Date: Fri, 23 Dec 2022 17:49:27 +0100 Subject: [PATCH 13/13] python: added Doxyfile to framework This is used to generate the documentation for the players. --- .../spn_python_framework/Doxyfile | 2658 +++++++++++++++++ 1 file changed, 2658 insertions(+) create mode 100644 docker4bots/spn_python_base/spn_python_framework/Doxyfile diff --git a/docker4bots/spn_python_base/spn_python_framework/Doxyfile b/docker4bots/spn_python_base/spn_python_framework/Doxyfile new file mode 100644 index 0000000..504e88a --- /dev/null +++ b/docker4bots/spn_python_base/spn_python_framework/Doxyfile @@ -0,0 +1,2658 @@ +# 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 = "SPN Python Bot Framework" + +# 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 = doc/ + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# 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 = NO + +# 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 = YES + +# 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 ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. 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 = src/ + +# 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 = *.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 \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# 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 = NO + +# 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: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a 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 + S +# (what the is depends on the OS and browser, but it is typically +# , /