Funktionsbibliotheken und APIs konsumieren

Um eine Funktionsbibliothek zu verwenden muss zunächst Build-System vorbereitet werden. Dazu müssen entsprechende Compiler- und Linker-Flags gesetzt werden. Ohne diese Anpassungen wird die Kompilierung davon ausgehen, dass keine externen Funktionsbibliotheken verwendet werden. Die Folge ist meist ein "undefined reference"-Fehler.

Im CMake sind folgende Anpassungen notwendig:

• Funktionsbibliothek über ein Find-Script auffinden lassen
• An das Target des Programms, das die Funktionsbibliothek verwenden soll, folgende Informationen anfügen:
  • zusätzliches Include-Verzeichnis, in dem die Header der Funktionsbibliothek enthalten sind
  • Pfad zur Funktionsbibliothek
  • Kompiler-Flags, die für die Verwendung der Bibliothek notwendig sind

Hier ein Beispiel für CMake-Projekt, dass die "LibXml2" als Funktionsbibliothek einbettet:

CMakeLists.txt

cmake_minimum_required(VERSION 3.10)
project(demo C)

set(CMAKE_C_STANDARD 11)

find_package(LibXml2 REQUIRED)

add_executable(demo main.c)
target_include_directories(demo PRIVATE ${LIBXML2_INCLUDE_DIR})
target_link_libraries(demo PRIVATE ${LIBXML2_LIBRARIES})
target_compile_definitions(demo PRIVATE ${LIBXML2_DEFINITIONS})

Im Source Code des Programms können nun die Header-Dateien der Bibliotheken eingebunden, und die Funktionen, Typen und Variablen verwendet werden.

main.c

/**
 * section: Tree
 * synopsis: Navigates a tree to print element names
 * purpose: Parse a file to a tree, use xmlDocGetRootElement() to
 *          get the root element, then walk the document and print
 *          all the element name in document order.
 * usage: tree1 filename_or_URL
 * test: tree1 test2.xml > tree1.tmp && diff tree1.tmp $(srcdir)/tree1.res
 * author: Dodji Seketeli
 * copy: see Copyright for the status of this software.
 */
#include <stdio.h>
#include <libxml/parser.h>
#include <libxml/tree.h>

/*
 *To compile this file using gcc you can type
 *gcc `xml2-config --cflags --libs` -o xmlexample libxml2-example.c
 */

/**
 * print_element_names:
 * @a_node: the initial xml node to consider.
 *
 * Prints the names of the all the xml elements
 * that are siblings or children of a given xml node.
 */
static void
print_element_names(xmlNode * a_node)
{
    xmlNode *cur_node = NULL;

    for (cur_node = a_node; cur_node; cur_node = cur_node->next) {
        if (cur_node->type == XML_ELEMENT_NODE) {
            printf("node type: Element, name: %s\n", cur_node->name);
        }

        print_element_names(cur_node->children);
    }
}


/**
 * Simple example to parse a file called "file.xml",
 * walk down the DOM, and print the name of the
 * xml elements nodes.
 */
int
main(int argc, char **argv)
{
    xmlDoc *doc = NULL;
    xmlNode *root_element = NULL;

    if (argc != 2)
        return(1);

    /*
     * this initialize the library and check potential ABI mismatches
     * between the version it was compiled for and the actual shared
     * library used.
     */
    LIBXML_TEST_VERSION

    /*parse the file and get the DOM */
    doc = xmlReadFile(argv[1], NULL, 0);

    if (doc == NULL) {
        printf("error: could not parse file %s\n", argv[1]);
    }

    /*Get the root element node */
    root_element = xmlDocGetRootElement(doc);

    print_element_names(root_element);

    /*free the document */
    xmlFreeDoc(doc);

    /*
     *Free the global variables that may
     *have been allocated by the parser.
     */
    xmlCleanupParser();

    return 0;
}

Funktionsbibliotheken können selbst andere Funktionsbibliotheken verwenden. Das Einbinden einer Funktionsbibliothek sorgt dafür, dass alle Abhängigkeiten automatisch nachgezogen werden.

HINWEIS: Unter Linux reicht das Installieren der benötigten Funktionsbibliotheken meist nicht aus, da diese keine Header enthalten. Die Header sind separat in einem Development-Paket enthalten. Beispiel: libev4 enthält nur die Funktionsbibliothek. Die Header müssen über libev-dev nachinstalliert werden.