Самостоятельная сборка Gmsh. Windows

Несмотря на то, что на сайте Gmsh'а можно найти исполняемые файлы, подходящие практически для любой операционной системы (Windows, Linux, Mac OS X), иногда требуется собрать его из исходников. Например, вы обладаете экзотической платформой, для которой Gmsh не имеет готовой сборки. Или вы хотите почувствовать всю мощь Gmsh-библиотеки, включив функции API в свой код. В этих случаях вам придется собрать Gmsh самому из исходных файлов. Скачать исходники, также как и исполняемые файлы, можно с сайта, причем и в том и в другом случае у вас есть возможность выбора версии, которую вы хотите иметь. По старой доброй привычке рекомендую скачивать исходники версии Gmsh 2.4.2, поскольку очередные попытки использования более современных версий (2.5.0 и 2.5.1) оказались для некоторых тестов неудачными. В то время как Gmsh 2.4.2, наш старый трудяга, все перелопатил на ура. В пользу новых версий Gmsh'а - новые опции и поддержка более современных форматов файлов. Однако для меня надежность важнее. Поэтому мы снова работаем с версией 2.4.2.

Построение исполняемых файлов и библиотек Gmsh'а мы будем рассматривать на тех платформах, к которым я имею доступ (вы уж извините), а именно Windows XP и Windows Server 2003, Ubuntu 10.04 Lucid Lynx (с графикой) и Linux Suse (без графики). Поскольку для сборки программы под Windows и под Unix-подобными платформами зачастую требуются различные телодвижения, сегодня мы остановимся на рассмотрении только Windows систем.
Конечная цель, которую мы перед собой поставим, - собрать исполняемый файл gmsh.exe, библиотеку gmsh.lib, а также запустить простейшую программу, использующую Gmsh API (иначе - как потрогать библиотеку?).
Как и многие OpenSource программы Gmsh предназначен в первую очередь для работы под Unix-системами. Поэтому при сборке в Windows используются те же средства и та же последовательность действий, что приняты в Unix - конфигурирование Makefile, компиляция и сборка (make), установка полученных исполняемых файлов и библиотек в соответствующие директории (make install). Правда, последний шаг при работе в Windows не столь очевиден, однако давайте обо всем по порядку.
Начиная с версии 2.4.1 Gmsh для конфигурирования перешел на платформо-независимую систему построения build-файлов (makefiles в Unix, projects/workspaces в Windows MS Visual Studio) CMake. При этом, для корректной работы необходима версия CMake не ниже 2.6.
Итак, скачайте исходники Gmsh'а необходимой версии. Сделать это можно отсюда. Папку, в которую вы разархивируете Gmsh, назовем 'GmshSrc', чтобы не привязываться к конкретной версии (вы можете не следовать моим советам и скачать версию свежее, чем 2.4.2). Прежде, чем идти дальше, необходимо отметить, что для сборки Gmsh'а, необходимо иметь еще некоторое количество дополнительных библиотек. Если вы не хотите собирать их из исходников, разработчики Gmsh'а предлагают скачать готовые Windows-сборки всех нужных библиотек с заголовочными файлами одним архивом. Вот ссылка. Папка, которую вы в итоге будете иметь, называется 'gmsh-dep'. Для удобства поместите ее в папку 'GmshSrc'.
Если же вы хотите собирать все нужные библиотеки самостоятельно (как вы уже, наверное, догадались, это тоже OpenSource проекты, предназначенные в первую очередь для Unix-систем), смотрите следующую запись в этом блоге, посвященную сборке Gmsh под Unix. Однако я никогда не пробовал этим заниматься (в смысле - собирать эти библиотеки под Windows), поэтому будем рассматривать вариант с готовой папкой 'gmsh-dep'.
Итак, допустим, вы скачали CMake версии 2.8.5 для 32-битной ОС Windows (вот ссылка, по которой вы можете скачать архив cmake-2.8.5-win32-x86.zip). Далее распакуйте архив в папку cmake-2.8.5-win32-x86. Среди исполняемых файлов, лежащих в cmake-2.8.5-win32-x86\bin\ есть cmake.exe, cmake-gui.exe и другие. cmake-gui.exe - это программа, которая имеет графический интерфейс, cmake.exe - нет. И поскольку мы работаем в Windows, предлагаю запустить cmake-gui.exe. Вы увидите следующее окно:

Нажимаем кнопку 'Browse Source..' и выбираем нашу папку с исходниками 'GmshSrc'. Затем нажимаем 'Browse Build..' и выбираем пустую папку 'GmshBuild', в которую CMake сохранит файлы проекта. Как-то так:

Теперь нажимаем кнопку 'Add Entry' и добавляем информацию о папке с программами, от которых зависит Gmsh, т.е. путь к папке 'gmsh-dep':
Name: CMAKE_PREFIX_PATH
Type: PATH
Value: D:/GmshSrc/gmsh-dep
Description: /*оставляем пустым*/

Нажимаем 'OK'. Переменная CMAKE_PREFIX_PATH добавлена. Далее нажимаем кнопку 'Configure'. Вам будет предложено выбрать компилятор, который вы хотите использовать. У меня установлена MS Visual Studio 2008, поэтому я выбираю 'Visual Studio 9 2008', и оставляю значение радио-кнопки в положении по умолчанию 'Use default native compilers':

Нажимаем 'Finish'. CMake собирает всю необходимую информацию для построения файлов проекта. Например, проверяет работоспособность C- и C++-компиляторов, ищет различные файлы и т.д. Возможно, на данном этапе вы получите неожиданные ошибки. Помнится, как-то раз CMake, например, требовал компилятор Фортрана. Если возникнут какие-то проблемы, пишите - будем разбираться. Если же все прошло гладко, CMake выдаст примерно следующее:

Gmsh has been configured for Windows with the following options: Ann Chaco DIntegration FlTree Fltk FltkJpeg FltkPng FltkZlib Gmm MathEx Med Metis NativeFileChooser Netgen NoSocklenT OpenGL RefBlas RefLapack Tetgen

C compiler: cl
C++ compiler: cl
Build type: RelWithDebInfo
Install prefix: C:/Program Files/gmsh

Run 'ccmake D:/GmshSrc' to fine-tune the configuration.

Configuring done

Что здесь можно отметить. В первой строке перечислены все опции Gmsh, с которыми он будет собран. Это значения по умолчанию, которые хранятся в файле 'CMakeLists.txt' в папке 'GmshSrc'. Чтобы изменить их, можно запустить программу 'ccmake.exe' из той же папки, что и 'cmake-gui.exe', и передать ей в качестве параметра путь до 'GmshSrc' (собственно, это CMake и предлагает сделать, говоря "Run 'ccmake D:/GmshSrc' to fine-tune the configuration"). Все то же самое можно сделать и из окна 'cmake-gui.exe', который в данный момент открыт перед вами:

Чтобы развернуть все опции, какие только возможны, нажмите галочку 'Advanced' (я обвел ее красным прямоугольником). Все то же самое можно сделать и из 'ccmake.exe'. Для изменения значения опции, ставьте/убирайте галочки, а строковые переменные просто вбивайте руками.
Есть еще один способ изменения опций. Это редактирование файла 'CMakeLists.txt' из папки 'GmshSrc' для изменения параметров по умолчанию (для загрузки измененной версии этого файла необходимо почистить кэш, в котором хранятся текущие значения параметров (для этого можно в программе 'cmake-gui.exe' нажать 'File->Delete Cache' или просто удалить файл 'CMakeCache.txt' из папки 'GmshBuild' и запустить 'cmake-gui.exe' заново)) или редактирование уже названного файла 'CMakeCache.txt', в котором хранятся текущие настройки опций (после изменения этого файла нужно перезагрузить кэш, нажав 'File->Reload Cache'). Однако, поскольку мы работаем в Windows, грех не воспользоваться графическими приложениями. И в этом смысле 'cmake-gui.exe' подходит лучше всего.
Примечание! Обратите внимание на параметр 'CMAKE_INSTALL_PREFIX'. Он содержит путь к папке, куда будут установлены исполняемый файл, библиотеки и заголовочные файлы Gmsh'а. В данном случае он указывает на папку 'C:/Program Files/gmsh'. Мы обязательно вспомним этот путь, когда будем писать код с использованием Gmsh API.
Если вас устраивают настройки опций, нажмите на 'Configure' еще раз. Теперь становится доступной кнопка 'Generate'. Нажимаем, и если все нормально, Cmake выдаст долгожданную фразу "Generating done". После этого CMake можно закрывать и запускать файл проекта, который лежит в папке 'GmshBuild'.
Всего имеется 11 проектов:
ALL_BUILD, clean_doc, gmsh, html, info, INSTALL, lib, PACKAGE, shared, txt, ZERO_CHECK
При запуске любого из этих проектов, откроется gmsh solution, содержащее все 11 проектов. Поэтому можно просто запустить файл 'gmsh.sln', находящийся в той же папке.
Чтобы собрать исполняемый файл 'gmsh.exe', статическую библиотеку 'gmsh.lib' или динамически подключаемую библиотеку 'gmsh.dll', во-первых, выбираем тип сборки, например, 'RelWithDebInfo', а также платформу (у меня по умолчанию Win32, но вдруг у вас 64-битная):

Затем нажимаем правой кнопкой мыши на соответствующем проекте в Solution Explorer (для 'exe' - gmsh, 'lib' - lib, 'dll' - shared) и выбираем 'Build':

Вуаля. Ждем довольно долго (хотя многое зависит от вашего компьютера), а затем лезем в папку, соответствующую типу сборки. В нашем случае - в папку 'GmshBuild/RelWithDebInfo'. Там находятся файлы 'gmsh.exe', 'Gmsh.lib' и 'Gmsh.dll'.
Если вам нужно было просто собрать библиотеку, то на этом шаге можно остановиться. Однако для эффективного использования Gmsh API в своем коде, соберите проект под названием 'INSTALL' тем же способом. В результате сборки все готовые к тому моменту исполняемые файлы, библиотеки и заголовочные файлы Gmsh'а попадут в папку 'C:\Program Files\gmsh', которая задавалась на этапе конфигурирования через переменную 'CMAKE_INSTALL_PATH'. Сборка проекта 'INSTALL' аналогична действию 'make install' в Unix'е, кто понимает о чем речь.

Ну и в заключение попробуем использовать библиотеку Gmsh'а в своем коде. К сожалению, до сих нет документации по использованию функций и классов Gmsh'а. Однако некоторые характерные средства использования Gmsh API показаны в примерах, которые находятся в папке 'GmshSrc/utils/api_demos'. Один из таких файлов мы и попробуем скомпилировать и запустить.
Для этого создаем пустой консольный С++ проект в MS Visual Studio. Затем добавляем в проект файл 'mainSimple.cpp' из указанной выше папки. Выбираем тип сборки Release (для сборки Debug работать не будет). Теперь добавляем библиотеку 'Gmsh.lib' в проект (для этого открываем свойства проекта и в разделе 'Linker->General' в поле 'Additional Library Directories' указываем путь до файла 'Gmsh.lib', а в разделе 'Linker->Input' в поле 'Additional Dependencies' пишем 'Gmsh.lib'), а также указываем путь к папке с заголовочными файлами Gmsh'а, которая формируется во время сборки проекта 'INSTALL' (для этого в свойствах проекта в разделе 'C/C++->General' в поле 'Additional Include Directories' указываем путь 'C:\Program Files\gmsh\include\gmsh'). И затем заветный 'Build' выдает нам долгожданный 'Build succeeded'. Так? Нет! Кроме библиотеки 'Gmsh.lib' потребуется некоторое количество дополнительных библиотек, которые можно подсмотреть в свойствах проекта, генерируемого CMake'ом. Опытным путем было получено, что необходимо включить такие библиотеки, как:

1. fltk.lib
2. fltkgl.lib
3. fltkforms.lib
4. fltkimages.lib
5. fltkjpeg.lib
6. fltkpng.lib
7. fltkz.lib
8. med.lib
9. hdf5.lib
10. blas.lib
11. lapack.lib
12. g2c.lib
13. gcc.lib
14. opengl32.lib
15. glu32.lib
16. wsock32.lib
17. comctl32.lib

Первые 13 библиотек содержатся в папке 'gmsh-dep/lib'. Добавлять сами библиотеки и пути к ним нужно способом, описанным выше для 'Gmsh.lib'. Если на вашем компьютере нет оставшихся 4 библиотек - поищите их в интернете и киньте в папку 'gmsh-dep/lib', чтобы не прописывать новые пути в свойствах проекта. Попробуйте собрать проект еще раз. Теперь все должно работать.

Поддержка OpenCASCADE
Возник довольно интересный вопрос по поводу сборки Gmsh'а под Windows с поддержкой OpenCASCADE. О том, зачем нужен OpenCASCADE, я писал здесь и здесь. Несмотря на то, что в готовой сборке под Windows от авторов Gmsh'а поддержка OCCT есть, в папке в дополнительными библиотеками gmsh-dep, от которых зависит Gmsh, вы не найдете библиотеки OCCT. Это связано, скорее всего, с тем, что библиотека OCCT огромна. Поэтому, для того, чтобы самому собрать Gmsh с поддержкой OCCT, прежде всего необходимо установить библиотеки OpenCASCADE на компьютер. Для Windows существует установочный файл, который можно скачать с сайта opencascade.org и который распакует все необходимые библиотеки, заголовочные файлы, документацию, примеры и т.д. в указанное вами место. По хорошему, установщик должен также прописать необходимые пути в системную переменную CASROOT. Однако практика показывает, что это происходит не всегда. Для того, чтобы проверить, что эта переменная среды инициализирована, вбейте в командной строке

echo %CASROOT%

Если вы устанавливали OCCT по умолчанию, то CASROOT будет указывать в C:\OpenCASCADEx.x.x, где x.x.x - это версия библиотеки. Может случиться так, что переменная CASROOT вообще не инициализирована. Однако, ни в том, ни в другом случае CMake не найдет нужных библиотек, когда вы будете переконфигурировать Gmsh, и поддержка OpenCASCADE не подключится. Почему так произойдет? Потому что CMake будет искать их не там, где они лежат на самом деле. Чтобы убедиться в этом, можете посмотреть файл CMakeLists.txt, который лежит в корневой папке исходников Gmsh'а и которым руководствуется CMake для поиска зависимостей. Для того, чтобы Cmake все-таки нашел необходимые библиотеки, нужно изменить переменную CASROOT. Она должна иметь вид:

echo %CASROOT%
C:\OpenCASCADEx.x.x\ros\inc;C:\OpenCASCADEx.x.x\ros\winY\vcZ\lib

где Y = ( 32 | 64 ) зависит от платформы, Z = ( 8 | 9 | 10 ) зависит от версии Visual Studio. Перед конфигурированием Gmsh'а не забудьте поставить галочку напротив ENABLE_OCC, если она там не стоит. Если все пройдет успешно, то в списке опций, с которыми собран Gmsh, вы увидите строку OpenCascade. Если ее нет, то проверьте еще раз все пути и переменную CASROOT.