Программирование на языке OpenOffice Basic и LibreOffice Basic

В настоящее время у человечества стоит задача автоматизировать и роботизировать наиболее опасные, трудоемкие, не интересные виды человеческой деятельности. Наиболее актуальна роботизация при выполнении боевых задач, видов деятельности, сопряженных с риском для жизни человека.

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

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

Программирование на OpenOffice Basic, LibreOffice Basic или OOo Basic позволяет автоматизировать часто повторяющиеся операции в бесплатных офисных программах, осуществить выгрузку документов из программы 1С Предприятие. Это позволяет значительно увеличить производительность труда.

1 OpenOffice Basic и LibreOffice Basic

OpenOffice Basic и LibreOffice Basic ранее назывались StarOffice Basic, StarBasic, OpenOffice.org Basic, OOo Basic. LibreOffice Basic в настоящее время развивается, опережая OpenOffice Basic, поэтому в дальнейшем будем преимущественно говорить о LibreOffice Basic.

OOo Basic схож с другими диалектами Basic, например, с Visual Basic for Application может иметь одинаковый программный код в широкой области применения.

OOo Basic позволяет программировать в пакетах офисных программ OpenOffice и LibreOffice, а также автоматизировать управляющие этими пакетами действия. OOo Basic не позволяет создавать самостоятельно выполняемые программы с расширением exe.

OOo Basic дает возможность создавать программы (кодировать) в текстовом редакторе OpenOffice Writer или LibreOffice Writer, табличном процессоре OpenOffice Calc или LibreOffice Calc, графическом редакторе OpenOffice Draw или LibreOffice Draw, редакторе презентаций OpenOffice Impress или LibreOffice Imress, в системе управления базами данных OpenOffice Base или LibreOffice Base. Программирование не доступно в редакторе формул OpenOffice Math или LibreOffice Math.

Макросы используются для автоматизации действий в OpenOffice.org. Макрос может автоматизировать такие действия, которые иначе потребовали бы длительных ручных манипуляций с возможными ошибками. В настоящее время автоматизированные действия наиболее легко выполняются написанием макросов в OOo Basic. Новая среда для макросов … должна облегчить использование других языков, но Basic все еще наиболее легкий в использовании. Вот несколько преимуществ использования языка OOo Basic для управления OOo [1]:

- поддерживает объекты COM (ActiveX) и расширенные возможности GUI в OpenOffice;

- это решение для нескольких платформ (Linux, Windows и т.д.).

Кроссплатформенность (совместимость с 32/64-битными системами, поддержка таких самых популярных операционных систем, как Microsoft Windows, GNU/Linux и Mac OS X), свободное распространение для бесплатного использования в частных и коммерческих целях, открытый исходный код придают LibreOffice Basic особую ценность.

В справке по OpenOffice или LibreOffice, вызываемой при нажатии на F1, в разделе «Макросы и программирование» можно получить львиную долю информации о программировании на OOo Basic.

В серии моих последующих книг вы сможете получить представление о LibreOffice Basic. Предложения можете отправлять на электронную почту da.irk.ru@mail.ru

2 Мой первый макрос: “Hello World” [1]

Откройте новый документ OOo. Используйте меню Сервис - Макросы - Управление макросами - OpenOffice.org Бэйсик, чтобы начать диалог макросов Macro. С левой стороны окна диалога найдите документ, который Вы только что открыли. Новый документ, вероятно, назван “untitled1” или Безымянный1. Кликните (нажмите левую клавишу мыши) справа ниже от “untitled1” на слове “standard”. Кликните кнопку Создать (New) далеко справа для создания нового модуля.

Использование имени “Module1”, вероятно, не лучшее решение. Когда у Вас открыто несколько документов и все они имеют модуль с именем “Module1”, то становится трудно работать с ними. Лучше назовем Ваш первый модуль “MyFirstModule”. Откроется среда редактирования и отладки макросов OOo Basic IDE. Введите (или скопируйте) текст, приведенный в Листинге 3.1.

Листинг 3.1: Ваш первый макрос, “Hello world”.

Кликните на кнопке с зеленым треугольничком ("Выполнить Basic") в верхней панели для выполнения Вашего первого макроса OOo Basic.

3 Левый Alt нажать одновременно с F11 для открытия OOo Basic IDE

4 Оператор REM или апостроф ' перед комментарием

Комментарии начинаются оператором REM или апострофом ' в начале строки или через несколько пробелов после оператора, например

'Программа начинается оператором Sub с именем Main

REM Комментарий для людей программа не выполняет

5 Циклы Do...Loop

Цикл Do While Условие … Loop проверяет перед каждым выполнением цикла истинно ли условие и выполняться пока (While) истинно условие:

Цикл Do Until Условие … Loop выполняется до (Until) истинности условия. Цикл выполняется, если условие ложно:

Цикл Do … Loop While Условие выполняется по крайней мере один раз и продолжает выполняться пока (While) истинно условие:

Цикл Do … Loop Until Условие выполняется один или большее число раз до (Until) наступления момента истинности условия

6 Группировка текста программ [1]

OOo Basic основан на процедурах и функциях, который задаются ключевыми словами Sub и Function – далее они будут называться процедурами (procedures, routines, subroutines) или соответственно функциями. Каждая процедура может вызывать другие процедуры. Разница между Sub и Function в том, что функция возвращает значение, а процедура – нет. Макрос на Листинг 3.2 получает текстовую строку от функции с именем HellowWorldString.

Листинг 3.2: “Hello world” с использованием процедуры и функции.

Каждый модуль (module) содержит набор процедур (функций). Библиотека (Library) содержит набор модулей. Документ (document) может содержать библиотеку или несколько библиотек. Библиотека может существовать также на уровне Приложения (application level), такого как OOo Writer.

7 Передача параметров процедурам и функциям

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

определяет процедуру, которая ожидает в качестве параметров целочисленное значение A и строку B [9; стр. 24].

Параметр в LibreOffice Basic по умолчанию передается по ссылке на ячейку памяти, в которой хранятся все изменения переменной, переданной в параметрах. Поэтому переменная, изменившаяся в процедуре или функции, при выходе из процедуры или функции возвращается в измененном виде:

В этом примере [9; стр. 24], значение A, которое определяется в функции Test, передается как параметр в функцию ChangeValue. Значение здесь изменяется на 20 и передается в TheValue, которое сохраняется, когда происходит выход из функции.

Вы можете также передать параметр по значению, если Вы не хотите, чтобы последующие изменения параметра затронули значение, которое было передано первоначально. Чтобы определить, что параметр нужно передать по значению, удостоверьтесь, что ключевое слово ByVal предшествует объявлению переменной в заголовке функции.

В предыдущем примере, если мы заменяем функцию ChangeValue на функцию

тогда переменная A остается незатронутой этим изменением. После вызова функции ChangeValue, переменная A сохраняет значение 10.

Примечание Метод для передачи параметров процедурам и функциям в OOo Basic фактически идентичен VBA. По умолчанию, параметры передаются по ссылке. Чтобы передавать параметры по значению, используйте ключевое слово ByVal. В VBA, Вы можете также использовать ключевое слово ByRef, чтобы вынудить параметр быть переданным по ссылке. OOo Basic не поддерживает это ключевое слово, потому что оно уже используется по умолчанию в процедурах OOo Basic.

8 Необязательные (Optional) параметры

Функции и процедуры можно вызвать, только если все необходимые параметры передаются во время вызова. OOo Basic позволяет Вам определять параметры как необязательные, то есть, если соответствующие значения не включены в запрос, OOo Basic передает пустой параметр. В примере [9; стр. 24]

параметр A обязателен, тогда как параметр B является необязательным. Функция IsMissing проверяет, передан ли параметр или нет.

' Проверка, присутствует ли параметр B фактически

B_Local = 0 ' Параметр B отсутствует -> значение по 'умолчанию 0

Пример сначала проверяет, передали ли параметр B и, в случае необходимости, передает этот параметр внутренней переменной B_Local. Если соответствующий параметр отсутствует, то значение по умолчанию (в этом случае, значение 0) передается B_Local, а не переданному параметру.

Примечание Ключевое слово ParamArray присутствующее в VBA не поддерживается в OOo Basic.

9 OpenOffice.org и LibreOffice API

OpenOffice и LibreOffice API (application programming interface) не является языком программирования, он только интерфейс программирования приложений в виде готового набора методов, предлагаемых сервисом для создания программного кода. OpenOffice и LibreOffice API содержат много сервисов (Services) и объектов (Objects).

API OpenOffice.org и LibreOffice используют Универсальные сетевые объекты - Universal Network Objects (UNO). Объекты, созданные с помощью разных языков программирования (Basic, C, C++, Java, Python) и технологий (Web, OLE, CLI, COM) взаимодействуют благодаря UNO на одном или многих компьютерах в локальной или сети Internet.

Способы использования StarBasic API в программировании на каком-то языке могут без особых усилий применяться для интеграции StarBasic API с другими поддерживаемыми языками программирования (Basic, C, C++, Java, Python).

9.1 Справочная информация по API OpenOffice.org и LibreOffice

Документация о сервисах, их свойствах, методах и интерфейсах сосредоточена в справочнике по OpenOffice.org API на сайте www.openoffice.org по ссылке:

Онлайн документация по Libreoffice API расположена по адресу:

9.2 Создание и обращение к объектам

Возглавляет иерархию объектов OOo Basic объект StarDesktop, являющийся глобальной переменной, менеджером всех документов OpenOffice или LibreOffice. Методы всегда доступного объекта StarDesktop позволяют создавать новые или открывать существующие документы OpenOffice или LibreOffice.

Объект ThisComponent является глобальной переменной, предоставляющей доступ к активному документу. Следующий программный код объявляет активный документ OpenOffice или LibreOffice как объект Doc:

Doc = ThisComponent 'Активный документ получает имя Doc

9.3 Сервисы LibreOffice Basic

Все сервисы OOo Basic начинаются с com.sun.star и составляют большой перечень, из которого наиболее важные:

- com.sun.star.chart содержит сервисы для построения графиков. Наиболее важным из них является ChartDocument(), который указывает данные для построения графика и некоторые общие характиристики (contains the services for charting. The most important one is ChartDocument() that specifies the data to use in the chart and some general characteristics [5; стр. 21]).

- com.sun.star.drawing содержит все сервисы, используемые для рисования линий, прямоугольников, кругов и т.д. (collects all services used for drawing line, rectangles, circles etc).

- com.sun.star.frame содержит сервисы Desktop(). Вы можете использовать этот сервис для открытия существующих документов или создания новых (contains the Desktop() service. You use this service to open existing documents or create new ones).

- com.sun.star.presentation предоставляет все сервисы для создания и работы с презентациями (provides all services to create and work with presentations).

- com.sun.star.sheet содержит сервисы для электронных таблиц. Сервис SpreadheetDocument() используется для работы с листами электронных таблиц (contains services for spreadsheets. Its SpreadheetDocument() service is used to work with spreadsheets).

- com.sun.star.table предоставляет все сервисы для таблиц в текстовых документах и электронных таблицах (provides all services for tables in text documents and spreadsheets).

- com.sun.star.text группы сервисов, связанных с текстовыми документами. Сервис TextDocument() предоставляет все интерфейсы, необходимые для работы с текстовыми документами (groups the services dealing with text documents. The TextDocument() service provides all interfaces needed to work with text documents).

9.4 Список всех сервисов, поддерживаемых LibreOffice Basic

Все поддерживаемые LibreOffice сервисы (1022 сервиса) отсортированы по алфавиту:

com.sun.star.i18n.IndexEntrySupplier_ja_phonetic (alphanumeric first) (grouped by consonant)

com.sun.star.i18n.IndexEntrySupplier_ja_phonetic (alphanumeric first) (grouped by syllable)

com.sun.star.i18n.IndexEntrySupplier_ja_phonetic (alphanumeric last) (grouped by consonant)

com.sun.star.i18n.IndexEntrySupplier_ja_phonetic (alphanumeric last) (grouped by syllable)

9.5 UNO структуры

UNO структуры могут быть объявлены использованием команды dim как новая (UNO structures can be declared using the OpenOffice.org Basic command dim as new [4]):

Или с помощью команды createUnoStruct (or by using the OpenOffice.org Basic command createUnoStruct):

Примечание: при объявлении UNO структуры, важен размер букв. Обратите внимание, что все до имени структуры написано строчными буквами, и что имя структуры начинается с прописной буквы.(Note: When declaring UNO structs, case is important. Note that everything up to the name of the struct is lowercase, and that the name of the struct is in TitleCase).

9.6 Определение свойств, методов, сервисов, интерфейсов объекта

Вы можете узнать, поддерживает ли объект конкретный сервис [8]:

Метод объектов getImplementationName() возвращает полное имя данного объекта. Используйте полное имя объекта для поиска в Интернете или в Руководстве разработчика:

Метод объектов getSupportedServiceNames() возвращает перечень всех сервисов, поддерживаемых объектом:

Метод CreateUnoService() - это короткий путь вместо вызова global service manager и затем вызова createInstance() для этого менеджера.

Приведённый выше вызов заменяет следующие два примера:

Следующий программный код отображает свойства, методы, интерфейсы произвольного объекта Obj при помощи его соответствующих свойств DBG_Properties, DBG_methods, DBG_SupportedInterfaces на примере объекта "com.sun.star.frame.Desktop"

Объект Obj имеет свойства, методы, интерфейсы UNO, представленные ниже.

Properties of object "com.sun.star.frame.Desktop" - свойства объекта:

Сервисы, поддерживаемые объектом "com.sun.star.frame.Desktop":

Сервисов, доступных в объекте "com.sun.star.frame.Desktop" нет.

Supported interfaces by object "com.sun.star.frame.Desktop" - интерфейсы, поддерживаемые объектом "com.sun.star.frame.Desktop":

Какие-то из свойств DBG_Properties, DBG_methods или DBG_SupportedInterfaces для других рассматриваемых объектов могут быть не доступны.

10 Приложения OpenOffice и LibreOffice

Макрос должен соответствовать типу документа, проверить тип документа можно с помощью SupportsService в следующем программном коде [2] с переводом комментариев в скобках:

Listing 482. Check for an Impress document before checking for a Draw document (проверка документа Impress перед проверкой документа Draw).

Следующую функцию макросы ниже вызывают для создания нового пустого документа LibreOffice Calc, LibreOffice Writer, LibreOffice Draw, LibreOffice Math или LibreOffice Impress, передавая при обращении к функции параметр docType$ соответственно scalc, swriter, sdraw, smath, and simpress.

Listing 483. Create a new document (создание нового документа).

REM Create a new empty document (Создание нового пустого документа)

REM consider document types of (предусматривается документ типов)

Dim noArgs() 'An empty array for the arguments (Пустой массив для аргументов)

Dim sURL As String 'URL of the document to load (URL-адрес документа для загрузки)

LoadEmptyDocument = StarDesktop.LoadComponentFromUrl(sURL, "_blank", 0, noArgs())

11 Использование диспетчера [7]

Для использования диспетчера вам необходимо будет получить два объекта API OOo — создать сервис com.sun.star.frame.DispatchHelper и получить доступ к фрейму (носителю GUI) целевого объекта. Далее нужно будет вызвать executeDispatch указав ему целевой фрейм и команду которую необходимо отправить указанному фрейму. Следующий код демонстрирует вставку из буфера обмена в позицию курсора:

Для использования некоторых команд вам также придётся создать массив содержащий аргументы команды — массив структур com.sun.star.beans.PropertyValue. В следующем коде, выполняющем вставку формулы в текущую (активную) ячейку Calc, как раз используется команда диспетчера требующая аргументов:

Online-документация, содержащая перечень команд диспетчеру: https://wiki.openoffice.org/wiki/Framework/Article/OpenOffice.org_3.x_Commands