Autodoc или exist: что лучше, преимущества и недостатки, способы оплаты, методы возврата товара, скорость отмены, условия доставки, обзор продукции, акции и цены

Autodoc Модуль

Модуль Autodoc

Основной единицей организации в файле autodoc является раздел, начинается со строки вида:
[SectionType = name]
Может быть много разделов одного типа, т.е.е., имеющий такое же имя ключа для раздела с именем typeName в функциях ниже. Каждый из них обычно имеет другое значение для записи имени, хотя это не обязательно, так как уникальность не обязательна, а разделы не обычно искал по имени. Все разделы того же типа содержатся в массиве, называемом коллекцией, и они доступ к их массиву показатель. Таким образом, функции для установки или получения значений из раздела все обратитесь к разделу по его типу typeName и его индексу sectInd .

Внутри раздела автодок содержит набор строк с парами ключ-значение, формы:
ключ = значение
Как правило, значения хранятся в виде строк, но можно использовать указанные ниже функции. для хранения или извлечения значений из строк, состоящих от 1 до 3 чисел с плавающей запятой или целые числа. Разделы одного типа не обязательно должны иметь одинаковый набор пары ключ-значение определены.

Каждая структура autodoc инициализируется разделом для хранения глобальных данных. в начале файла, до определения каких-либо фактических разделов.Эти данные доступны через вызовы с typeName из «PreData» и sectInd из 0. Программы на C должны использовать ADOC_GLOBAL_NAME, который определяется как «PreData»; Программы на Фортране должны вызывать
целое число * 4 AdocGetStandardNames (globalName, zvalueName)
, чтобы получить эту строку, а также важную строку ADOC_ZVALUE_NAME, которая определяется как «ZValue». Эта функция возвращает -1, если строка не помещается в предоставленный символьный аргумент.

Комментарии к строкам, начинающимся с #, могут встречаться в любом месте автодока.Они будут сохраняться при чтении и, как правило, снова записываться перед тот же предмет.

Автодок можно записать в виде XML-файла, а достаточно простые XML-файлы могут быть прочитаны и сохранены в структуре autodoc. При чтении из файла XML корневым элементом может быть что угодно, хотя вызывающая программа может настаивать на конкретное имя элемента. При записи корневой элемент будет , если автодок не был прочитан из файла XML или имя было установлено с помощью AdocSetXmlRootElement.Каждый раздел записывается как дочерний элемент верхнего уровня корневого элемента в этой форме: , хотя глобальный раздел записывается как без имени. Пары «ключ-значение» внутри раздела все записываются как дочерние элементы дочернего элемента верхнего уровня с форма значение . Пустые значения разрешены и записываются как <ключ />. Любой XML-файл, соответствующий этой структуре, может быть прочитан; а именно, каждый дочерний элемент верхнего уровня должен иметь атрибут имени, кроме PreData, а дочерние элементы эти узлы должны быть простыми парами ключ-значение без атрибутов или дочерних элементов.Последний будет просто потерян; см. AdocXmlReadStatus.

Заголовок для включения: autodoc.h

int AdocRead (const char * имя файла)
int AdocXmlReadStatus (int * sectNotElem, int * sectNoName, int * childNotElem, int * childAttribs, int * valueNotText, int * multipleChilds)
int AdocOpenImageMetadata (const char * filename, int addMdoc, int * montage, int * numSect, int * sectType)
int AdocGetImageMetaInfo (int * монтаж, int * numSect, int * sectType)
int AdocNew ()
int AdocGetCurrentIndex ()
int AdocSetCurrent (индекс числа)
void AdocClear (индекс целого числа)
недействителен AdocDone ()
int AdocWrite (const char * имя файла)
недействителен AdocSetWriteAsXML (int asXML)
интервал AdocGetWriteAsXML ()
int AdocGetXmlRootElement (char ** строка)
int AdocSetXmlRootElement (элемент const char *)
int AdocAppendSection (const char * имя файла)
int AdocPrintToString (char * строка, int stringSize, int writeAll)
интервал AdocOrderWriteByValue (const char * typeName)
int AdocAddSection (const char * typeName, const char * name)
int AdocInsertSection (const char * typeName, int sectInd, const char * name)
интервал AdocDeleteSection (const char * typeName, int sectInd)
int AdocChangeSectionName (const char * typeName, int sectInd, const char * newName)
int AdocLookupSection (const char * typeName, const char * name)
интервал AdocLookupByNameValue (const char * typeName, int nameValue)
интервал AdocFindInsertIndex (const char * typeName, int nameValue)
int AdocTransferSection (const char * typeName, int sectInd, int toAdocInd, const char * newName, int byValue)
int AdocSetKeyValue (const char * typeName, int sectInd, const char * key, const char * value)
int AdocSetInteger (const char * typeName, int sectInd, const char * key, int ival)
int AdocSetTwoIntegers (const char * typeName, int sectInd, const char * key, int ival1, int ival2)
int AdocSetThreeIntegers (const char * typeName, int sectInd, const char * key, int ival1, int ival2, int ival3)
int AdocSetIntegerArray (const char * typeName, int sectInd, const char * key, int * ivals, int numVals)
int AdocSetFloat (const char * typeName, int sectInd, const char * key, float val)
int AdocSetTwoFloats (const char * typeName, int sectInd, const char * key, float val1, float val2)
int AdocSetThreeFloats (const char * typeName, int sectInd, const char * key, float val1, значение с плавающей запятой 2, значение с плавающей запятой 3)
int AdocSetFloatArray (const char * typeName, int sectInd, const char * key, float * vals, int numVals)
int AdocSetDouble (const char * typeName, int sectInd, const char * key, double val)
int AdocDeleteKeyValue (const char * typeName, int sectInd, const char * key)
интервал AdocGetNumCollections ()
int AdocGetCollectionName (int collInd, char ** строка)
int AdocGetSectionName (const char * typeName, int sectInd, char ** строка)
int AdocGetNumberOfSections (const char * typeName)
int AdocGetNumberOfKeys (const char * typeName, int sectInd)
int AdocGetKeyByIndex (const char * typeName, int sectInd, int keyInd, char ** ключ)
int AdocGetValTypeAndSize (const char * typeName, int sectInd, const char * key, int * valType, int * numTokens)
int AdocGetString (const char * typeName, int sectInd, const char * key, char ** string)
int AdocGetInteger (const char * typeName, int sectInd, const char * key, int * val1)
int AdocGetFloat (const char * typeName, int sectInd, const char * key, float * val1)
int AdocGetDouble (const char * typeName, int sectInd, const char * key, double * val1)
int AdocGetTwoIntegers (const char * typeName, int sectInd, const char * key, int * val1, int * val2)
int AdocGetTwoFloats (const char * typeName, int sectInd, const char * key, float * val1, float * val2)
int AdocGetThreeIntegers (const char * typeName, int sectInd, const char * key, int * val1, int * val2, int * val3)
int AdocGetThreeFloats (const char * typeName, int sectInd, const char * key, float * val1, float * val2, float * val3)
int AdocGetIntegerArray (const char * typeName, int sectInd, const char * key, int * array, int * numToGet, int arraySize)
int AdocGetFloatArray (const char * typeName, int sectInd, const char * key, float * array, int * numToGet, int arraySize)
int AdocWriteInteger (ФАЙЛ * fp, const char * key, int ival)
int AdocWriteTwoIntegers (ФАЙЛ * fp, const char * key, int ival1, int ival2)
int AdocWriteThreeIntegers (ФАЙЛ * fp, const char * key, int ival1, int ival2, int ival3)
int AdocWriteIntegerArray (ФАЙЛ * fp, const char * key, int * ivals, int numVals)
int AdocWriteFloat (ФАЙЛ * fp, const char * key, float val)
int AdocWriteTwoFloats (ФАЙЛ * fp, const char * key, float val1, float val2)
int AdocWriteThreeFloats (ФАЙЛ * fp, const char * key, float val1, float val2, float val3)
int AdocWriteFloatArray (ФАЙЛ * fp, const char * key, float * vals, int numVals)
int AdocWriteKeyValue (ФАЙЛ * fp, const char * ключ, const char * значение)
int AdocWriteSectionStart (ФАЙЛ * fp, const char * ключ, const char * значение)

int AdocRead (const char * filename)

Считывает файл XML, совместимый с autodoc или autodoc, из файла, указанного в , имя_файла , и возвращает индекс нового автодока (пронумерованный с нуля) или -1 в случае ошибки.

int AdocXmlReadStatus (int * sectNotElem, int * sectNoName, int * childNotElem, int * childAttribs, int * valueNotText, int * multipleChilds)

Возвращает, был ли последний прочитанный файл XML-файлом, а также информацию об аспектах. который нельзя было закодировать как автодок, если последний файл был файлом XML. Каждое значение — количество вхождений проблемы:
sectNotElem , если дочерний элемент верхнего уровня не является элементом,
sectNoName , если дочерний элемент верхнего уровня не имеет атрибута имени,
childNotElem , если дочерний элемент дочерний элемент верхнего уровня не является элементом,
childAttribs , если дочерний элемент имеет атрибуты,
valueNotText , если значение дочернего элемента не является текстом,
multipleChilds , если дочерний элемент дочернего элемента верхнего уровня имеет несколько дочерних элементов.
Если у дочернего элемента верхнего уровня есть атрибуты, отличные от «name», они станут пары ключ-значение неотличимы от пар, поступающих от дочерних узлов, и есть нет индикатора, что это произошло. Возвращаемое значение — 0, если файл не был XML, 1, если он был и не имел проблем, или -1, если это был XML и были некоторые из этих проблем.

int AdocOpenImageMetadata (const char * filename, int addMdoc, int * montage, int * numSect, int * sectType)

Попробуйте прочитать файл метаданных изображения и определить его свойства.Так и будет найдите и попробуйте прочитать файл с именем filename , если addMdoc равен 0, в противном случае он добавит ‘.mdoc’ к имени файла . Возвращает ненулевое значение в монтаж , если в файле указан монтаж; количество секций в numSect и 1 для автодока метаданных или 2 для автодока серии изображений в sectType . Возвращаемое значение — это индекс автодока или -1 для ошибка открытия или чтения файла, -2, если файл не существует, или -3, если это ни один из типов файлов метаданных.

int AdocGetImageMetaInfo (int * монтаж, int * numSect, int * sectType)

Определяет, является ли текущий автодок допустимым автодоком метаданных изображения и возвращает ненулевое значение в монтаж , если файл указывает монтаж; количество разделы в numSect ; и 1 для автодока метаданных, 2 для автодока серии изображений, или 3 для любого другого автодока с разделами с именем ZValue (включая атрибуты для файла HDF). Возвращаемое значение -3, если оно не является одним из этих типов автодокументов.

int AdocNew ()

Находит неиспользуемый автодок во внутреннем массиве, если он существует, или создает новый, если нет, делает его текущим и возвращает его индекс или -1 в случае ошибки.

int AdocGetCurrentIndex ()

Возвращает текущий индекс autodoc или -1, если его нет.

интервал AdocSetCurrent (индекс числа)

Делает autodoc по адресу index текущим autodoc. Индекс пронумерован с нуля. Возвращает -1, если индекс выходит за границы.

void AdocClear (int index)

Удаляет все данные из автодока , индекс и отмечает их как неиспользуемые.

недействителен AdocDone ()

Удаляет все автодокументы и возвращает модуль в исходное состояние.

int AdocWrite (const char * filename)

Записывает текущий автодок в файл, указанный в filename . Возвращает 1 при отказе от резервного копирования предыдущего файла и -1 при других ошибках

недействителен AdocSetWriteAsXML (int asXML)

Устанавливает текущий автодок для записи в формате XML, если asXML не равно нулю.

интервал AdocGetWriteAsXML ()

Возвращает 1, если текущий автодок должен быть записан как XML, 0, если нет, -1, если недопустимый текущий автодок

int AdocGetXmlRootElement (char ** строка)

Возвращает копию имени корневого элемента в строку , если файл был загружен из XML; он должен быть освобожден с помощью free , если он не равен NULL. Возвращает -1 для нет текущего autodoc или 1 для ошибки памяти.

int AdocSetXmlRootElement (элемент const char *)

Устанавливает имя корневого элемента равным , элемент при записи в виде файла XML; возвращает -1 для нет текущего autodoc или 1 для ошибки памяти.

int AdocAppendSection (const char * filename)

Добавляет последний раздел текущего автодока к файлу, указанному имя_файла ; или полностью записывает автодок, если он записывается как XML. Возвращает -1 в случае ошибок.

int AdocPrintToString (char * строка, int stringSize, int writeAll)

Записывает либо весь текущий автодок, если writeAll не равен нулю, либо только последний в противном случае в строку , размер которой должен быть указан как stringSize . Возвращает -1 для всех ошибок, в том числе не вписывающихся в строку.

int AdocOrderWriteByValue (const char * typeName)

Устанавливает следующую запись так, чтобы все разделы в коллекции с именем typeName выводятся после глобального раздела и по значению их имен. Возвращает 1 при ошибке памяти.

int AdocAddSection (const char * typeName, const char * name)

Добавляет раздел типа, заданного параметром typeName и именем, заданным параметром name .Возвращает индекс нового раздела в коллекции разделов этого type или -1 в случае ошибки.

int AdocInsertSection (const char * typeName, int sectInd, const char * name)

Вставляет раздел с именем по имени в коллекцию разделов типа typeName , по индексу sectInd . Коллекция должна существовать, если sectInd не равен 0, и sectInd должно быть меньше или равно количеству разделов в этой коллекции.Возвращает -1 в случае ошибки.

int AdocDeleteSection (const char * typeName, int sectInd)

Удаляет раздел с индексом sectInd из коллекции разделов типа typeName . Возвращает -1 в случае ошибки.

int AdocChangeSectionName (const char * typeName, int sectInd, const char * newName)

Изменяет имя раздела с индексом sectInd из коллекции разделов type typeName от до newName .Возвращает -1 в случае ошибки.

int AdocLookupSection (const char * typeName, const char * name)

Ищет раздел типа, заданного параметром typeName и именем, заданным параметром name . Возвращает индекс этого раздела в коллекции разделов этого type, -1, если его нет, или -2 в случае ошибки.

интервал AdocLookupByNameValue (const char * typeName, int nameValue)

Ищет раздел типа, указанного в typeName , имя которого преобразуется в целое число. значение имяЗначение .Возвращает индекс этого раздела в коллекции разделов этого типа, -1, если его нет, или -2 в случае ошибки. При звонке из Фортрана обязательно чтобы передать фактическое значение в файл, так как эта процедура не будет корректировать переданное значение уменьшилось на 1.

int AdocFindInsertIndex (const char * typeName, int nameValue)

Смотрит в коллекции разделов типа typeName , преобразует их имена в строки в целые числа и возвращает индекс первого раздела, имя которого больше, чем nameValue , количество разделов, если такого раздела нет, или -1 в случае ошибки (в том числе, если существует раздел, имя которого преобразуется в nameValue ).Это вернулось index, таким образом, можно использовать в вызове AdocInsertSection для поддержки разделов в числовой порядок по значению имени.

int AdocTransferSection (const char * typeName, int sectInd, int toAdocInd, const char * newName, int byValue)

Переносит все пары ключ / значение из раздела индекса sectInd в коллекцию введите typeName текущего autodoc в раздел того же типа в autodoc с индексом toAdocInd , с именем newName . Если byValue отличен от нуля, новый имя преобразуется в целое число, и раздел вставляется, чтобы сохранить разделы в целях. При необходимости создается коллекция в принимающем автодоке; новый раздел может уже существовать или будет создан при необходимости; существующие ценности с тот же ключ перезаписывается. Чтобы передать глобальные данные, установите typeName на ADOC_GLOBAL_NAME, sectInd до 0 и byValue до 0; newName игнорируется. Возврат -1, если исходный раздел не существует, -2 для неверного индекса для нового автодока или newName NULL (если typeName не ADOC_GLOBAL_NAME), -3 в случае невозможности добавления нового раздел или -4, если не удалось добавить пару «ключ-значение».

int AdocSetKeyValue (const char * typeName, int sectInd, const char * key, const char * value)

Устанавливает для пары ключ-значение значение ключ и значение в разделе с индексом sectInd в коллекции разделов типа typeName . Секция уже должен существовать. Заменяет существующее значение, если оно есть. значение может быть ЗНАЧЕНИЕ NULL. Возвращает -1 в случае ошибки.

int AdocSetInteger (const char * typeName, int sectInd, const char * key, int ival)

Устанавливает значение ключа в целое число ival в разделе с индексом sectInd в коллекции разделов типа typeName .Секция уже должен существовать. Заменяет существующее значение, если оно есть. Возвращает -1 в случае ошибки.

int AdocSetTwoIntegers (const char * typeName, int sectInd, const char * key, int ival1, int ival2)

Как AdocSetInteger, за исключением того, что значение установлено на два целых числа ival1 ival2 .

int AdocSetThreeIntegers (const char * typeName, int sectInd, const char * key, int ival1, int ival2, int ival3)

Как AdocSetInteger, за исключением того, что значение установлено на три целых числа ival1 ival2 ival3 .

int AdocSetIntegerArray (const char * typeName, int sectInd, const char * key, int * ivals, int numVals)

Подобно AdocSetInteger, за исключением того, что значение установлено в массив целых чисел numVals в ivals .

int AdocSetFloat (const char * typeName, int sectInd, const char * key, float val)

Устанавливает значение ключа в значение с плавающей запятой val в разделе с индексом sectInd в коллекции разделов типа typeName .Секция уже должен существовать. Заменяет существующее значение, если оно есть. Возвращает -1 в случае ошибки.

int AdocSetTwoFloats (const char * typeName, int sectInd, const char * key, float val1, значение с плавающей запятой2)

Как AdocSetFloat, за исключением того, что значение установлено на два числа с плавающей запятой. val1 val2 .

int AdocSetThreeFloats (const char * typeName, int sectInd, const char * key, float val1, значение с плавающей запятой2, значение с плавающей запятой3)

Как AdocSetFloat, за исключением того, что значение установлено на три числа с плавающей запятой. val1 val2 val3 .

int AdocSetFloatArray (const char * typeName, int sectInd, const char * key, float * vals, int numVals)

Подобно AdocSetFloat, за исключением того, что значение установлено в массив numVals float в вальс .

int AdocSetDouble (const char * typeName, int sectInd, const char * key, double val)

Как и AdocSetFloat, за исключением того, что val является двойным

int AdocDeleteKeyValue (const char * typeName, int sectInd, const char * key)

Удаляет пару ключ-значение, соответствующую ключу в разделе с индексом sectInd в коллекции разделов типа typeName .Очищает и ключ, и значение. Возвращает -1 в случае ошибки.

int AdocGetNumCollections ()

Возвращает количество коллекций разделов, исключая глобальную коллекцию данных, или -1, если текущего автодока нет.

int AdocGetCollectionName (int collInd, char ** строка)

Возвращает имя коллекции с индексом collInd в строку , т. е. выделено и должно быть освобождено с помощью свободных . Индекс нумеруется от 0 (1 в Фортране). и исключает сбор глобальных данных.Возвращает -1 в случае ошибок.

int AdocGetSectionName (const char * typeName, int sectInd, char ** string)

Получает имя раздела с индексом sectInd в коллекции секции типа typeName . Возвращает имя в строке , которое выделяется и должен быть освобожден с помощью бесплатно . Возвращает -1 в случае ошибок.

int AdocGetNumberOfSections (const char * typeName)

Возвращает количество разделов типа typeName .Возвращает -1 при ошибках, и 0, если нет секций данного типа.

int AdocGetNumberOfKeys (const char * typeName, int sectInd)

Возвращает количество пар ключ-значение в разделе с индексом sectInd в коллекции разделов типа typeName . Возвращает -1 в случае ошибок.

int AdocGetKeyByIndex (const char * typeName, int sectInd, int keyInd, char ** key)

Получает ключ с индексом keyInd в разделе с индексом sectInd в коллекции секций типа тип Наименование . Возвращает копию ключа в ключ , который должен быть освобожден с помощью свободного , или возвращает NULL, если этот ключ был удален. Возвращает -1 в случае ошибок.

int AdocGetValTypeAndSize (const char * typeName, int sectInd, const char * key, int * valType, int * numTokens)

Возвращает информацию о строке значения, соответствующей ключу в разделе с индексом sectInd в коллекции секций типа typeName : тип значения (ADOC_ONE_INT и т. Д.) В valType и количество разделенных пробелами токенов в строке в numTokens .Возвращает -1, если ключ имеет значение null, раздел не существует или ошибка памяти; возвращает 1, если key не встречается в данном разделе или если значение равно нулю.

int AdocGetString (const char * typeName, int sectInd, const char * key, char ** string)

Получает строку значения, совпадающую с ключом в разделе с индексом sectInd в коллекции разделов типа typeName . Возвращает копию значение в строке ; он должен быть освобожден с помощью бесплатно .Возвращает -1, если ключ null, раздел не существует или ошибка памяти; возвращает 1, если key не встречается в данном разделе или если значение равно нулю.

int AdocGetInteger (const char * typeName, int sectInd, const char * key, int * val1)

Подобно AdocGetString, за исключением того, что он извлекает одно целое число из значения строка и возвращает ее значение в val1 .

int AdocGetFloat (const char * typeName, int sectInd, const char * key, float * val1)

Как AdocGetInteger, за исключением того, что возвращает число с плавающей запятой

int AdocGetDouble (const char * typeName, int sectInd, const char * key, double * val1)

Как и AdocGetInteger, за исключением того, что возвращает двойной

int AdocGetTwoIntegers (const char * typeName, int sectInd, const char * key, int * val1, int * val2)

Подобно AdocGetString, за исключением того, что он извлекает два целых числа из значения строка и возвращает их значения в val1 и val2 .

int AdocGetTwoFloats (const char * typeName, int sectInd, const char * key, float * val1, float * val2)

Как AdocGetTwoIntegers, за исключением того, что возвращает числа с плавающей запятой.

int AdocGetThreeIntegers (const char * typeName, int sectInd, const char * key, int * val1, интервал * значение2, интервал * значение3)

Подобно AdocGetString, за исключением того, что он извлекает три целых числа из значения строка и возвращает их значения в val1 , val2 и val3 .

int AdocGetThreeFloats (const char * typeName, int sectInd, const char * key, float * val1, float * val2, float * val3)

Как AdocGetThreeIntegers, за исключением того, что возвращает числа с плавающей запятой.

int AdocGetIntegerArray (const char * typeName, int sectInd, const char * key, int * array, int * numToGet, int arraySize)

Подобно AdocGetString, за исключением того, что он извлекает набор целых чисел из строка значения и возвращает их значения в массиве , размер которого указан в размер массива . Установите numToGet равным количеству получаемых значений или 0, чтобы получить все ценности; в последнем случае возвращается numToGet с числом извлеченных значений. Возвращает -1 для ошибок при синтаксическом анализе, слишком мало значений на строки, или недостаточно места в массиве, а также при сбоях в получение строки значения.

int AdocGetFloatArray (const char * typeName, int sectInd, const char * key, float * array, int * numToGet, int arraySize)

Как AdocGetIntegerArray, за исключением того, что возвращает числа с плавающей запятой.

int AdocWriteInteger (ФАЙЛ * fp, const char * key, int ival)

ФУНКЦИИ ПРЯМОГО ПИСАНИЯ

int AdocWriteTwoIntegers (ФАЙЛ * fp, const char * key, int ival1, int ival2)

Как AdocWriteInteger, за исключением того, что значение установлено на два целых числа ival1 ival2 .

int AdocWriteThreeIntegers (FILE * fp, const char * key, int ival1, int ival2, int ival3)

Как AdocWriteInteger, за исключением того, что значение установлено на три целых числа ival1 ival2 ival3 .

int AdocWriteIntegerArray (ФАЙЛ * fp, const char * key, int * ivals, int numVals)

Подобно AdocWriteInteger, за исключением того, что значение установлено в массив из numVals целые числа в формате ivals .

int AdocWriteFloat (ФАЙЛ * fp, const char * key, float val)

Подобно AdocWriteInteger, за исключением того, что установлено значение с плавающей запятой или .

int AdocWriteTwoFloats (ФАЙЛ * fp, const char * key, float val1, float val2)

Подобно AdocWriteInteger, за исключением того, что значение установлено на два числа с плавающей запятой val1 val2 .

int AdocWriteThreeFloats (ФАЙЛ * fp, const char * key, float val1, float val2, float val3)

Подобно AdocWriteInteger, за исключением того, что значение установлено на потоки с плавающей запятой val1 val2 val3 .

int AdocWriteFloatArray (ФАЙЛ * fp, const char * key, float * vals, int numVals)

Подобно AdocWriteInteger, за исключением того, что значение установлено в массив из numVals плавает в вальс .

int AdocWriteKeyValue (ФАЙЛ * fp, const char * ключ, const char * значение)

Записывает одну пару ключ-значение непосредственно в файл в fp из строк в key и значение . Возвращает 1 при ошибке записи.

int AdocWriteSectionStart (ФАЙЛ * fp, const char * ключ, const char * значение)

Записывает заголовок раздела непосредственно в файл в fp из строк в key и значение . Возвращает 1 при ошибке записи.

— документация Sphinx C Autodoc Extension 0.4.0

Переменные конфигурации

c_autodoc_roots

Список каталогов, которые будут использоваться для поиска файлов, представленных в Директивы. Каталоги относятся к документации исходный каталог, часто это conf.py .

Список каталогов будет просматриваться по порядку, поэтому при дублировании именованных файлов будет использоваться первый из найденных в списке каталогов.

Пример:

 c_autodoc_roots = ['мой / источник / каталог', 'другой / источник / каталог']
 

Тогда директива вида:

 . . autocfunction :: some_file.c :: some_function
 

будет сначала искаться как my / source / dir / some_file.c , затем, если он не найден, он будет выполняться поиск как other / source / dir / some_file.c . Опять же это относительно верхний каталог исходной документации.

c_autodoc_compilation_database

Путь к база данных компиляции.База данных компиляции относится к исходному каталогу документации, часто где conf.py есть.

База данных компиляции будет использоваться в качестве источника параметров компиляции для каждого файла. Если файл указан в базе данных компиляции более одного раза, только первый экземпляр файла будет использоваться. Важное значение имеет каталог , запись для каждого файла. Запись каталога будет передана libclang через рабочий каталог флаг. -working-directory позволяет включать и другие относительные пути аргументы, которые необходимо обрабатывать последовательно.

Примечание

В настоящее время libclang поддерживает только базы данных компиляции с именами compile_commands.json .

c_autodoc_compilation_args

Список аргументов для передачи libclang. Это можно использовать для установки общих определяет, что используется только для документации и / или избегания областей кода, которые имеют проблемы с анализом документации.

Например, следующее приведет к тому, что libclang проанализирует исходные файлы с определениями SPHINX_DOCS и МОДЕЛИРОВАНИЕ :

 c_autodoc_compilation_args = ["-DSPHINX_DOCS", "-DSIMULATION"]
 

c_autodoc_compilation_args добавлены для всех обрабатываемых файлов. c_autodoc_compilation_args будет применяться после любых предоставленных аргументов Автор: c_autodoc_compilation_database.

autodoc — Документация Source.Python v705

# . ./autodoc.py

"" "Этот модуль предоставляет класс для автоматического создания документации." ""

# ================================================= ============================
# >> ИМПОРТ
# ================================================= ============================
# Python
import sys

from path import Path

# ================================================= ============================
# >> ВСЕ ДЕКЛАРАЦИЯ
# ================================================= ============================
__all__ = ('SphinxError',
           "СфинксПроект",
           )


# ================================================= ============================
# >> КЛАССЫ
# ================================================= ============================
[документы] класс SphinxError (Исключение):
    "" "Исключение возникает при создании, построении или генерации документов Sphinx."" "


[документы] класс SphinxProject (объект):
    "" "Представление проекта Сфинкса." ""

[документы] def __init __ (self, package_dir, project_dir):
        "" "Инициализировать объект проекта Sphinx. 

        : параметр str каталог_пакета:
            Путь к пакету для документирования.
        : параметр str каталог_проекта:
            Путь к проекту Sphinx или куда его нужно сохранить.
        "" "
        self._package_dir = Путь (каталог_пакета)
        self._project_dir = Путь (каталог_проекта)
        self.validate_package ()

    @свойство
    def project_dir (сам):
        "" "Вернуть каталог проекта.: rtype: Путь
        "" "
        вернуть self._project_dir

    @свойство
    def project_source_dir (сам):
        "" "Вернуть исходный каталог проекта.

        : rtype: Путь
        "" "
        вернуть self.project_dir / 'источник'

    @свойство
    def project_build_dir (сам):
        "" "Вернуть каталог сборки проекта.

        : rtype: Путь
        "" "
        вернуть self.project_dir / 'build'

    @свойство
    def package_dir (сам):
        "" "Вернуть каталог пакета как объект Path.: rtype: Путь
        "" "
        вернуть self._package_dir

[документы] def project_exists (self):
        "" "Вернуть True, если проект Sphinx существует. 

        : rtype: bool
        "" "
        вернуть self.project_dir.isdir ()

[документы] def package_exists (сам):
        "" "Вернуть True, если пакет существует.

        : rtype: bool
        "" "
        вернуть self.package_dir.isdir ()

[docs] def create (self, author, project_name = None, version = '1'):
        "" "Создайте новый проект Sphinx.

        : param str автор:
            Имя автора пакета.: param str имя_проекта:
            Название проекта, которое отображается в документации. Если
            Нет, это будет имя пакета.
        : param str версия:
            Версия проекта / пакета.
        : поднять ValueError:
            Возникает, если проект уже существует.
        : поднять ValueError:
            Возникает, если пакет не существует.
        : поднять SphinxError:
            Возникает, если при создании произошла ошибка.
        "" "
        если self.project_exists ():
            Raise ValueError ('Проект уже существует.')

        self.validate_package ()
        self. project_dir.mkdir ()

        из sphinx.quickstart import main

        argv = [
            '', # Будет пропущено.
            '-q', # Не запускать интерактивный режим
        ]

        если имя_проекта - Нет:
            имя_проекта = self.package_dir.namebase

        argv.append ('- p {0}'. format (имя_проекта))
        argv.append ('- {0}'. формат (автор))
        argv.append ('- v {0}'. формат (версия))

        argv.extend ([
            ул (сам.каталог_проекта),
            '--sep', # Разделить исходный код и каталог сборки
            '--ext-autodoc', # Включить autodoc
            '--no-makefile',
            '--no-batchfile'
        ])

        # Хакерский, но обязательный, потому что sphinx читает sys.argv, даже если вы
        # передать список в main ()
        old_argv = sys.argv
        sys.argv = argv
        пытаться:
            основной (sys.argv)
        Кроме:
            поднять SphinxError
        Ну наконец то:
            sys.argv = old_argv

[документы] def generate_project_files (self, sub_dir = ''):
        "" "Сгенерируйте файлы проекта (` *. rst` файлы).

        : param str sub_dir:
            Поддиректория: attr: `project_source_dir`, где находится модуль
            документация будет создана в формате.
        : поднять ValueError:
            Возникает, если проект и / или пакет не существует.
        : поднять SphinxError:
            Возникает, если во время генерации произошла ошибка.
        "" "
        self.validate_project_and_package ()

        из sphinx.apidoc import main
        argv = [
            '', # Будет пропущено.
            '-e', # Отдельные страницы / файлы для каждого модуля
            '-o',
            ул (сам.каталог-источника_проекта / подкаталог),
            str (self.package_dir), # Пакет в документ
        ]

        # Хакерский, но обязательный, потому что sphinx читает sys.argv, даже если вы
        # передать список в main ()
        old_argv = sys.argv
        sys.argv = argv
        пытаться:
            основной (sys.argv)
        Кроме:
            поднять SphinxError
        Ну наконец то:
            sys. argv = old_argv

[документы] def build (self, clean = False):
        "" "Создайте проект Sphinx.

        : param bool clean:
            Если True, будет создана чистая сборка.: поднять ValueError:
            Возникает, если проект и / или пакет не существует.
        : поднять SphinxError:
            Возникает, если во время сборки произошла ошибка.
        "" "
        self.validate_project_and_package ()
        если чистый:
            self.project_build_dir.rmtree_p ()

        add_to_path = self.package_dir отсутствует в sys.path
        если add_to_path:
            sys.path.append (str (self.package_dir.parent))

        из основного импорта сфинкса
        argv = [
            '', # Будет пропущено.str (self.project_source_dir),
            str (self.project_build_dir),
        ]

        # Хакерский, но обязательный, потому что sphinx читает sys.argv, даже если вы
        # передать список в main ()
        old_argv = sys.argv
        sys.argv = argv
        пытаться:
            основной (sys. argv)
        кроме SystemExit как e:
            если e.code! = 0:
                поднять SphinxError
        Ну наконец то:
            sys.argv = old_argv
            если add_to_path:
                sys.path.remove (str (self.package_dir.parent))

[документы] def quickstart (self, author, project_name = None, version = '1'):
        "" "Оболочка для создания, генерации и построения документации.

        : param str автор:
            Автор проекта.
        : param str имя_проекта:
            Название проекта.
        : param str версия:
            Версия проекта.
        "" "
        если не self.project_exists ():
            self.create (автор, имя_проекта, версия)

        self.generate_project_files ()
        себя.строить()

[документы] def validate_project_and_package (self):
        "" "Проверить проект и пакет.

        : поднять ValueError:
            Возникает, если проект или пакет не существует.
        "" "
        self.validate_project ()
        self.validate_package ()

[документы] def validate_project (self):
        "" "Подтвердите проект. 

        : поднять ValueError:
            Возникает, если проект не существует.
        "" "
        если не self.project_exists ():
            поднять ValueError (
                'Создайте проект перед созданием файлов проекта.')

[документы] def validate_package (self):
        "" "Проверить пакет.

        : поднять ValueError:
            Возникает, если пакет не существует.
        "" "
        если не self.package_exists ():
            Raise ValueError ('Пакет не существует.')
 

linuxdoc.autodoc — LinuxDoc 20210324 документация

Autodoc FAQ

Какие версии прошивки поддерживаются?

Вы можете найти поддерживаемые версии прошивки здесь: Скачать

Какие производители поддерживаются?

Autodoc поддерживает файлы конфигурации из межсетевых экранов Fortinet, Watchguard, SonicWall и Palo Alto Networks.

Система лицензирования

Autodoc время от времени обновляется, чтобы не отставать от последних версий файлов конфигурации брандмауэра. У нас очень простая система лицензирования на годовой основе. Каждая лицензия Autodoc включает в себя возможность скачать программу сроком на один год. По истечении этого года вы можете продолжать использовать программное обеспечение, но вы больше не можете скачать программу. Если вы хотите загрузить снова, вам понадобится новая лицензия.

Какую лицензию мне нужно купить?

В основном доступно четыре различных лицензии: «Autodoc для WatchGuard», «Autodoc для Fortinet »,« Autodoc для SonicWALL »и« Autodoc для Palo Alto Networks ». Кроме того, существуют лицензии на различное количество межсетевых экранов, для которых вы хотите создать документацию. (1, до 10, до 20, до 50, без ограничений). Неважно, создаете ли вы документы для себя. брандмауэры или брандмауэры вашего клиента. Просто число должно быть правильным.

ВНИМАНИЕ: Лицензия на 1 межсетевой экран. не позволяет изменять верхний и нижний колонтитулы распечатываемого отчета. Пакетный экспорт HTML из командной строки также невозможно с лицензией на 1 единицу.

Может ли Autodoc экспортировать документацию в редактируемый формат?

Autodoc может экспортировать в HTML.

Можно ли изменить / адаптировать верхний и нижний колонтитулы в печатном документе?

Если у вас есть лицензия на 10 или более брандмауэров, вы можете изменить текст в верхнем и нижнем колонтитулах.

Сколько лицензий мне нужно для брандмауэра-кластера?

Кластер из двух межсетевых экранов (активный-активный или активно-пассивный) считается одним межсетевым экраном для Autodoc. Тот означает, что вам нужна только одна лицензия для кластера, а не две.

Как я могу создать документацию для Watchguard XTM / XTMv или Firebox / FireboxV?

Вам потребуется лицензия Autodoc для Watchguard . Используйте диспетчер политик, чтобы сохранить конфигурацию в файл (меню «Файл-> Сохранить-> Как файл»).С помощью WebUI вы можете загрузить файл конфигурации как файл .gz (меню «Система-> Файл конфигурации-> Загрузить»). Теперь вы можете распаковать файл .gz и найти файл конфигурации как .xml. Откройте этот файл конфигурации (.xml) с помощью Autodoc.

Как я могу создать документацию по брандмауэру Fortinet?

Вам потребуется лицензия Autodoc для Fortinet . Для создания документации необходимо: сделайте резервную копию конфигурации Fortinet в файл.cfg (Меню Система-> Статус-> Резервное копирование). Этот файл можно открыть с помощью Autodoc.

Как я могу создать документацию по SonicWALL?

Вам потребуется лицензия Autodoc для SonicWALL . Для создания документации необходимо: сделайте резервную копию настроек SonicWALL в файл .exp (Меню Система-> Настройки-> Настройки экспорта). Этот файл можно открыть с помощью Autodoc.

Как я могу создать документацию по межсетевому экрану Palo Alto Networks?

Вам потребуется лицензия Autodoc для Palo Alto Networks .Для создания документации необходимо: сделайте резервную копию настроек Palo Alto Networks в файл .xml (Меню Устройство-> Настройка-> Операции-> Экспорт-> Экспорт именованного снимка конфигурации). Этот файл можно открыть с помощью Autodoc.

Как получить лицензионные ключи?

Лицензионные ключи доставляются по электронной почте.