Работа с INI-файлами на Ассемблере

Конфигурационные ini-файлы появились в самых первых версиях Windows. Изначально в них хранились только настройки Windows, а затем они стали использоваться для хранения параметров других приложений. Начиная с Windows 95, Microsoft объявил ini-файлы устаревшими и с тех пор предлагает использовать системный реестр для хранения всех настроек и данных программ. Лично я считаю, что приложения должны быть легко переносимыми между компьютерами, а также легко и полностью деинсталлироваться, поэтому внедрение в систему должно быть минимальным. Хранение всех настроек в ini-файле или в xml-файле в папке с программой - это, на мой взгляд, самое правильное решение, а в реестр нужно залезать только в случае крайней необходимости.

Несложная структура формата ini-файлов позволяет легко обрабатывать их программно и имеет достаточно понятный вид для чтения и изменения человеком. Работать с ini-файлами из приложения одно удовольствие: чтобы читать параметры из файла конфигурации достаточно всего трех функций GetPrivateProfileString (строковые данные), GetPrivateProfileInt (числовые данные) и GetPrivateProfileStruct (двоичные данные), а вот для записи данных обратно есть только две функции WritePrivateProfileString (строковые данные) и WritePrivateProfileStruct (двоичные данные). Отдельной функции для записи числовых значений по какой-то причине не предусмотрено. Но это все хорошо, когда вы обрабатываете ini-файл с известной структурой, когда в приложении заранее определены имена секций и названия ключей.


А вот случай посложнее, когда в связи с особенностью работы приложения, структура ini-файла неизвестна. Или если известны имена секций, но количество и список ключей и их значений могут меняться. Парсить ini-файл с неизвестным содержимым самостоятельно - задача не самая тривиальная. При кажущейся простоте структуры, в файле могут быть комментарии, строки могут быть отформатированы разными способами, ключи и значения могут быть разделены как пробелами, так и табуляциями, да мало ли еще может быть вариантов. К счастью, разработчики WinAPI позаботились об этом, и система способна полностью парсить ini-файлы самостоятельно. Сегодня я расскажу, как на Ассемблере прочитать структуру секций, все ключи и их значения из произвольного ini-файла.

Сперва определим в сегменте данных переменные, в которые будут записаны все нужные нам значения.Список секций ini-файла можно получить при помощи функции GetPrivateProfileSectionNames. Она вернет список имен секций в виде последовательности ASCIIZ-строк, окончание списка - нулевой байт. Количество секций и размер блока памяти для них нигде в документации не оговорены, мне кажется, что одного килобайта для этого будет достаточно.


Содержимое секций можно прочитать другой функцией - GetPrivateProfileSection. Она вернет список ключей и их значений в виде ASCIIZ-строк в формате "ключ=значение". Окончание списка также определяется нулевым байтом. Все комментарии удаляются, а строки, которые не соответствуют формату ini-файла, игнорируются. При этом максимальный размер полезного содержимого секции, как сказано в описании функции, не должен превышать 32 килобайта. Может быть это утверждение справедливо для более старых версий Windows, а на современных системах, как показала практика, штатными средствами совершенно спокойно обрабатываются файлы с размером секций в несколько мегабайт.


И вот этот список нам все-таки придется парсить самостоятельно. Имя ключа и его значение всегда разделено знаком равенства "=" без пробелов, независимо от того, как эта строчка была записана в исходном файле. Разработчики WinAPI и тут нам очень помогли. Ведь по сути все значения в ini-файле являются строками и то, как будет представлено их значение, зависит исключительно от функции, которой это значение будет запрошено. Это надо будет учитывать при ручной обработке данных из файла. Полностью код для парсинга ini-файла выглядит примерно так:Для удобства обработки имена секций копируются в переменную sname, а имена и значения ключей, соответственно, в переменные key и value. Места в коде, где эти значения можно обрабатывать, выделены комментариями.

Еще немного полезной информации. Для того, чтобы сбросить кешированные данные на диск и сразу задействовать изменения после записи в ini-файл, надо вызвать функцию WriteProfileString или WritePrivateProfileString, передав им в качестве имени секции, наименования ключа и строки значения NULL:Для продвинутых пользователей расскажу еще про один способ работы с ini-файлами. Windows позволяет рассматривать секции ini-файлов с ключами и их значениями как набор свойств и предоставляет COM-интерфейсы IPropertyBag или IPropertyBag2 для работы с ними. Но сперва пачка недостающих данных для работы с COM-объектами.Для связки секции с объектом используется недокументированная функция из библиотеки shlwapi.dll SHCreatePropertyBagOnProfileSection. Она мало того, что она не имеет описания на сайте MSDN, так еще и экспортируется исключительно по ординалу 472. Как и большинство COM-функций, функция работает только с юникодными строками.После связывания секции с объектом становятся доступны два метода: Read для чтения значений ключей и Wrtite для их записи. Перед чтением и записью значений ключей обязательно надо заполнять структуру VARIANT, в частности поле vt. Там должен быть тип данных, которые ожидаются при чтении или передаются при записи. Если значение ключа не соответствует указанному типу, то функция завершится с ошибкой. Также при использовании метода Read надо учитывать такую особенность, что значение ключа, обрамленное кавычками, будет получено вместе с этими кавычками, тогда как функция GetPrivateProfileString вернет содержимое строки внутри кавычек. Также не забывайте освобождать выделенную системой память после чтения значений ключей.

В описании интерфейса IPropertyBag2 есть еще два интересных метода, а именно CountProperties для получения количества свойств в списке и GetPropertyInfo для получения информации. Велик соблазн реализовать с их помощью перебор всех ключей секции, но не тут-то было. При попытке вызова этих методов для объекта секции ini-файла, они завершаются с ошибкой, так как объект такого типа не поддерживает в полной мере интерфейс IPropertyBag2. Поэтому читать значения можно только для заведомо известных названий ключей.

Кроме методов интерфейсов в библиотеке shlwapi.dll есть еще несколько функций для работы с наборами параметров, в нашем случае это ключи ini-файлов. Как и основная функция, эти функции доступны только по ординалам. Вот их актуальный список с указанием ординала и протитипа.

493 - SHPropertyBag_ReadType (ppb, pszPropName, VARIANT* pv, VARTYPE vt);
494 - SHPropertyBag_ReadStr (ppb, pwzPropName, LPWSTR psz, int cch);
495 - SHPropertyBag_WriteStr (ppb, pwzPropName, LPCWSTR psz);
496 - SHPropertyBag_ReadLONG (ppb, pwzPropName, LONG* pl);
497 - SHPropertyBag_WriteLONG (ppb, pwzPropName, LONG l);
498 - SHPropertyBag_ReadBOOLOld (ppb, pwzPropName, BOOL* bDefault);
499 - SHPropertyBag_WriteBOOL (ppb, pwzPropName, BOOL fValue);
505 - SHPropertyBag_ReadGUID (ppb, pwzPropName, GUID* pguid);
506 - SHPropertyBag_WriteGUID (ppb, pwzPropName, const GUID* pguid);
507 - SHPropertyBag_ReadDWORD (ppb, pwzPropName, DWORD* pdw);
508 - SHPropertyBag_WriteDWORD (ppb, pwzPropName, DWORD dw);
512 - SHPropertyBag_ReadPIDL (ppb, pwzPropName, LPITEMIDLIST* ppidl);
513 - SHPropertyBag_WritePIDL (ppb, pwzPropName, LPCITEMIDLIST pidl);
520 - SHPropertyBag_ReadBSTR (ppb, pwzPropName, BSTR* pbstr);
521 - SHPropertyBag_ReadPOINTL (ppb, pwzPropName, POINTL* ppt);
522 - SHPropertyBag_WritePOINTL (ppb, pwzPropName, const POINTL* ppt);
523 - SHPropertyBag_ReadRECTL (ppb, pwzPropName, RECTL* prc);
524 - SHPropertyBag_WriteRECTL (ppb, pwzPropName, const RECTL* prc);
525 - SHPropertyBag_ReadPOINTS (ppb, pwzPropName, POINTS* ppt);
526 - SHPropertyBag_WritePOINTS (ppb, pwzPropName, const POINTS* ppt);
527 - SHPropertyBag_ReadSHORT (ppb, pwzPropName, SHORT* psh);
528 - SHPropertyBag_WriteSHORT (ppb, pwzPropName, SHORT sh);
529 - SHPropertyBag_ReadInt (ppb, pwzPropName, INT* piResult);
530 - SHPropertyBag_WriteInt (ppb, pwzPropName, INT iValue);
531 - SHPropertyBag_ReadStream (ppb, pwzPropName, IStream** ppstm);
532 - SHPropertyBag_WriteStream (ppb, pwzPropName, IStream* pstm);
534 - SHPropertyBag_ReadBOOL (ppb, pwzPropName, BOOL* pfResult);
535 - SHPropertyBag_Delete (ppb, pszPropName);
Если внимательно посмотреть, то можно заметить, что некоторые функции, в основном для чтения-записи числовых значений, практически дублируют друг друга. По-моему ситуация, когда надо прочитать значение именно конкретного байта, крайне редкая. Еще стоит обратить внимание на функции, которые работают со структурами, например, с POINT или RECT. Такие наборы данных хранятся в ini-файле в виде следующих записей:

[options]
; Структура POINT
my_pt.x=100
my_pt.y=200

; Структура RECT
my_rc.left=0
my_rc.top=0
my_rc.right=50
my_rc.bottom=95
Это очень удобно, так как достаточно будет запросить значение одного ключа, соответственно, это будут ключи my_pt и my_rc, чтобы загрузить в приложение уже заполненную структуру. GUID'ы записываются в соответствии с принятым шаблоном:

[options]
; GUID
my_guid={55272A00-42CB-11CE-8135-00AA004BB851}
Функции для чтения-записи строк работают с тем же особенностями, что и методы, то есть строковые значения в кавычках читаются вместе с кавычками. Булевые данные хранятся в виде числовых значений, -1 для TRUE и 0 для FALSE.

В списке есть две функции, заслуживающие отдельного внимания: SHPropertyBag_ReadType и SHPropertyBag_Delete. С помощью первой можно получить тип значения ключа до того, как запрашивать это значение. Вторая используется для удаления ключа. Вопреки названию функции, запись о ключе в ini-файле не удаляется, а только очищается его значение.В приложении примеры программ с исходными текстами, одна из которых парсит находящийся рядом с ней ini-файл и выводит его структуру в окно лога, а вторая читает и записывает значения ключей с помощью COM.

Комментарии

Добавить комментарий

Для вставки цитаты выделите текст и нажмите сюда

Имя*:

Текст комментария (не более 2000 символов)*:

*Все поля обязательны для заполнения.

Комментарии, содержащие рекламу, ненормативную лексику, оскорбления и т.п., а также флуд и сообщения не по теме, будут удаляться. Нарушителям может быть заблокирован доступ к сайту.