<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
  <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
  %gtkdocentities;
]>
<book id="index">

  <bookinfo>
    <title>&package_name; SDK Reference</title>
    <releaseinfo>
      <para>
        The following is a description of API that plugin developers can use to
        extend or add new features to Builder.
      </para>
    </releaseinfo>
    <copyright>
      <year>2014-2019</year>
      <holder>Christian Hergert, et al.</holder>
    </copyright>
  </bookinfo>

  <part id="libide-api">
    <title>API Reference</title>
    <chapter>
      <title>Extending Builder</title>
      <xi:include href="xml/ide-application-addin.xml"/>
      <xi:include href="xml/ide-buffer-addin.xml"/>
      <xi:include href="xml/ide-pipeline-addin.xml"/>
      <xi:include href="xml/ide-build-target-provider.xml"/>
      <xi:include href="xml/ide-command-provider.xml"/>
      <xi:include href="xml/ide-completion-provider.xml"/>
      <xi:include href="xml/ide-config-view-addin.xml"/>
      <xi:include href="xml/ide-config-provider.xml"/>
      <xi:include href="xml/ide-context-addin.xml"/>
      <xi:include href="xml/ide-device-provider.xml"/>
      <xi:include href="xml/ide-diagnostic-provider.xml"/>
      <xi:include href="xml/ide-editor-addin.xml"/>
      <xi:include href="xml/ide-editor-page-addin.xml"/>
      <xi:include href="xml/ide-extension-adapter.xml"/>
      <xi:include href="xml/ide-extension-set-adapter.xml"/>
      <xi:include href="xml/ide-extension-util-private.xml"/>
      <xi:include href="xml/ide-frame-addin.xml"/>
      <xi:include href="xml/ide-hover-provider.xml"/>
      <xi:include href="xml/ide-omni-bar-addin.xml"/>
      <xi:include href="xml/ide-preferences-addin.xml"/>
      <xi:include href="xml/ide-rename-provider.xml"/>
      <xi:include href="xml/ide-runner-addin.xml"/>
      <xi:include href="xml/ide-runtime-provider.xml"/>
      <xi:include href="xml/ide-search-provider.xml"/>
      <xi:include href="xml/ide-session-addin.xml"/>
      <xi:include href="xml/ide-symbol-resolver.xml"/>
      <xi:include href="xml/ide-test-provider.xml"/>
      <xi:include href="xml/ide-toolchain-provider.xml"/>
      <xi:include href="xml/ide-tree-addin.xml"/>
      <xi:include href="xml/ide-workbench-addin.xml"/>
      <xi:include href="xml/ide-workspace-addin.xml"/>
    </chapter>

    <chapter>
      <title>Core</title>
      <xi:include href="xml/ide-build-ident.xml"/>
      <xi:include href="xml/ide-context.xml"/>
      <xi:include href="xml/ide-debug.xml"/>
      <xi:include href="xml/ide-global.xml"/>
      <xi:include href="xml/ide-log.xml"/>
      <xi:include href="xml/ide-macros.xml"/>
      <xi:include href="xml/ide-notification.xml"/>
      <xi:include href="xml/ide-notifications.xml"/>
      <xi:include href="xml/ide-object-box.xml"/>
      <xi:include href="xml/ide-object.xml"/>
      <xi:include href="xml/ide-settings.xml"/>
      <xi:include href="xml/ide-transfer.xml"/>
      <xi:include href="xml/ide-transfer-manager.xml"/>
      <xi:include href="xml/ide-version-macros.xml"/>
      <xi:include href="xml/ide-version.xml"/>
    </chapter>

    <chapter>
      <title>IO</title>
      <xi:include href="xml/ide-content-type.xml"/>
      <xi:include href="xml/ide-gfile.xml"/>
      <xi:include href="xml/ide-line-reader.xml"/>
      <xi:include href="xml/ide-marked-content.xml"/>
      <xi:include href="xml/ide-path.xml"/>
      <xi:include href="xml/ide-persistent-map-builder.xml"/>
      <xi:include href="xml/ide-persistent-map.xml"/>
      <xi:include href="xml/ide-pkcon-transfer.xml"/>
      <xi:include href="xml/ide-pty-intercept.xml"/>
    </chapter>

    <chapter>
      <title>Gui</title>
      <xi:include href="xml/ide-application.xml"/>
      <xi:include href="xml/ide-cell-renderer-fancy.xml"/>
      <xi:include href="xml/ide-command.xml"/>
      <xi:include href="xml/ide-environment-editor.xml"/>
      <xi:include href="xml/ide-fancy-tree-view.xml"/>
      <xi:include href="xml/ide-frame-header.xml"/>
      <xi:include href="xml/ide-frame.xml"/>
      <xi:include href="xml/ide-grid-column.xml"/>
      <xi:include href="xml/ide-grid.xml"/>
      <xi:include href="xml/ide-gui-global.xml"/>
      <xi:include href="xml/ide-gutter.xml"/>
      <xi:include href="xml/ide-header-bar.xml"/>
      <xi:include href="xml/ide-line-change-gutter-renderer.xml"/>
      <xi:include href="xml/ide-marked-view.xml"/>
      <xi:include href="xml/ide-notifications-button.xml"/>
      <xi:include href="xml/ide-omni-bar.xml"/>
      <xi:include href="xml/ide-page.xml"/>
      <xi:include href="xml/ide-pane.xml"/>
      <xi:include href="xml/ide-panel.xml"/>
      <xi:include href="xml/ide-preferences-surface.xml"/>
      <xi:include href="xml/ide-preferences-window.xml"/>
      <xi:include href="xml/ide-primary-workspace.xml"/>
      <xi:include href="xml/ide-search-button.xml"/>
      <xi:include href="xml/ide-surface.xml"/>
      <xi:include href="xml/ide-surfaces-button.xml"/>
      <xi:include href="xml/ide-tagged-entry.xml"/>
      <xi:include href="xml/ide-transfer-button.xml"/>
      <xi:include href="xml/ide-transient-sidebar.xml"/>
      <xi:include href="xml/ide-tree-model.xml"/>
      <xi:include href="xml/ide-tree-node.xml"/>
      <xi:include href="xml/ide-tree.xml"/>
      <xi:include href="xml/ide-workbench.xml"/>
      <xi:include href="xml/ide-worker.xml"/>
      <xi:include href="xml/ide-workspace.xml"/>
    </chapter>

    <chapter>
      <title>Greeter</title>
      <xi:include href="xml/ide-clone-surface.xml"/>
      <xi:include href="xml/ide-greeter-section.xml"/>
      <xi:include href="xml/ide-greeter-workspace.xml"/>
    </chapter>

    <chapter>
      <title>Code</title>
      <xi:include href="xml/ide-buffer-change-monitor.xml"/>
      <xi:include href="xml/ide-buffer-manager.xml"/>
      <xi:include href="xml/ide-buffer.xml"/>
      <xi:include href="xml/ide-code-enums.xml"/>
      <xi:include href="xml/ide-code-index-entries.xml"/>
      <xi:include href="xml/ide-code-index-entry.xml"/>
      <xi:include href="xml/ide-code-indexer.xml"/>
      <xi:include href="xml/ide-code-types.xml"/>
      <xi:include href="xml/ide-diagnostic.xml"/>
      <xi:include href="xml/ide-diagnostics-manager.xml"/>
      <xi:include href="xml/ide-diagnostics.xml"/>
      <xi:include href="xml/ide-file-settings.xml"/>
      <xi:include href="xml/ide-formatter-options.xml"/>
      <xi:include href="xml/ide-formatter.xml"/>
      <xi:include href="xml/ide-highlight-engine.xml"/>
      <xi:include href="xml/ide-highlight-index.xml"/>
      <xi:include href="xml/ide-highlighter.xml"/>
      <xi:include href="xml/ide-indent-style.xml"/>
      <xi:include href="xml/ide-indenter.xml"/>
      <xi:include href="xml/ide-language.xml"/>
      <xi:include href="xml/ide-location.xml"/>
      <xi:include href="xml/ide-range.xml"/>
      <xi:include href="xml/ide-spaces-style.xml"/>
      <xi:include href="xml/ide-symbol-node.xml"/>
      <xi:include href="xml/ide-symbol-tree.xml"/>
      <xi:include href="xml/ide-symbol.xml"/>
      <xi:include href="xml/ide-text-edit.xml"/>
      <xi:include href="xml/ide-text-iter.xml"/>
      <xi:include href="xml/ide-text-util.xml"/>
      <xi:include href="xml/ide-unsaved-file.xml"/>
      <xi:include href="xml/ide-unsaved-files.xml"/>
    </chapter>

    <chapter>
      <title>Source View</title>
      <xi:include href="xml/ide-completion-context.xml"/>
      <xi:include href="xml/ide-completion-display.xml"/>
      <xi:include href="xml/ide-completion-list-box-row.xml"/>
      <xi:include href="xml/ide-completion-proposal.xml"/>
      <xi:include href="xml/ide-completion-types.xml"/>
      <xi:include href="xml/ide-completion.xml"/>
      <xi:include href="xml/ide-snippet-chunk.xml"/>
      <xi:include href="xml/ide-snippet-context.xml"/>
      <xi:include href="xml/ide-snippet-parser.xml"/>
      <xi:include href="xml/ide-snippet-private.xml"/>
      <xi:include href="xml/ide-snippet-storage.xml"/>
      <xi:include href="xml/ide-snippet-types.xml"/>
      <xi:include href="xml/ide-snippet.xml"/>
      <xi:include href="xml/ide-source-search-context.xml"/>
      <xi:include href="xml/ide-source-style-scheme.xml"/>
      <xi:include href="xml/ide-source-view-enums.xml"/>
      <xi:include href="xml/ide-source-view.xml"/>
      <xi:include href="xml/ide-hover-context.xml"/>
    </chapter>

    <chapter>
      <title>Editor</title>
      <xi:include href="xml/ide-editor-page.xml"/>
      <xi:include href="xml/ide-editor-search.xml"/>
      <xi:include href="xml/ide-editor-sidebar.xml"/>
      <xi:include href="xml/ide-editor-surface.xml"/>
      <xi:include href="xml/ide-editor-utilities.xml"/>
      <xi:include href="xml/ide-editor-workspace.xml"/>
    </chapter>

    <chapter>
      <title>Threading and Processes</title>
      <xi:include href="xml/ide-environment-variable.xml"/>
      <xi:include href="xml/ide-environment.xml"/>
      <xi:include href="xml/ide-subprocess-launcher.xml"/>
      <xi:include href="xml/ide-subprocess-supervisor.xml"/>
      <xi:include href="xml/ide-subprocess.xml"/>
      <xi:include href="xml/ide-task.xml"/>
      <xi:include href="xml/ide-thread-pool.xml"/>
    </chapter>

    <chapter>
      <title>Foundry</title>
      <xi:include href="xml/ide-build-log.xml"/>
      <xi:include href="xml/ide-build-manager.xml"/>
      <xi:include href="xml/ide-pipeline.xml"/>
      <xi:include href="xml/ide-pipeline-stage-launcher.xml"/>
      <xi:include href="xml/ide-pipeline-stage-mkdirs.xml"/>
      <xi:include href="xml/ide-pipeline-stage-transfer.xml"/>
      <xi:include href="xml/ide-pipeline-stage.xml"/>
      <xi:include href="xml/ide-build-system-discovery.xml"/>
      <xi:include href="xml/ide-build-system.xml"/>
      <xi:include href="xml/ide-build-target.xml"/>
      <xi:include href="xml/ide-compile-commands.xml"/>
      <xi:include href="xml/ide-config-manager.xml"/>
      <xi:include href="xml/ide-config.xml"/>
      <xi:include href="xml/ide-dependency-updater.xml"/>
      <xi:include href="xml/ide-deploy-strategy.xml"/>
      <xi:include href="xml/ide-device-info.xml"/>
      <xi:include href="xml/ide-device-manager.xml"/>
      <xi:include href="xml/ide-device.xml"/>
      <xi:include href="xml/ide-fallback-build-system.xml"/>
      <xi:include href="xml/ide-foundry-compat.xml"/>
      <xi:include href="xml/ide-foundry-enums.xml"/>
      <xi:include href="xml/ide-foundry-types.xml"/>
      <xi:include href="xml/ide-local-device.xml"/>
      <xi:include href="xml/ide-run-manager.xml"/>
      <xi:include href="xml/ide-runner.xml"/>
      <xi:include href="xml/ide-runtime-manager.xml"/>
      <xi:include href="xml/ide-runtime.xml"/>
      <xi:include href="xml/ide-simple-build-system-discovery.xml"/>
      <xi:include href="xml/ide-simple-build-target.xml"/>
      <xi:include href="xml/ide-simple-toolchain.xml"/>
      <xi:include href="xml/ide-test-manager.xml"/>
      <xi:include href="xml/ide-test-private.xml"/>
      <xi:include href="xml/ide-test.xml"/>
      <xi:include href="xml/ide-toolchain-manager.xml"/>
      <xi:include href="xml/ide-toolchain.xml"/>
      <xi:include href="xml/ide-triplet.xml"/>
    </chapter>

    <chapter>
      <title>VCS</title>
      <xi:include href="xml/ide-directory-vcs.xml"/>
      <xi:include href="xml/ide-vcs-cloner.xml"/>
      <xi:include href="xml/ide-vcs-config.xml"/>
      <xi:include href="xml/ide-vcs-enums.xml"/>
      <xi:include href="xml/ide-vcs-file-info.xml"/>
      <xi:include href="xml/ide-vcs-initializer.xml"/>
      <xi:include href="xml/ide-vcs-monitor.xml"/>
      <xi:include href="xml/ide-vcs-uri.xml"/>
      <xi:include href="xml/ide-vcs.xml"/>
    </chapter>

    <chapter>
      <title>Search</title>
      <xi:include href="xml/ide-search-engine.xml"/>
      <xi:include href="xml/ide-search-reducer.xml"/>
      <xi:include href="xml/ide-search-result.xml"/>
    </chapter>

    <chapter>
      <title>Terminal</title>
      <xi:include href="xml/ide-terminal-page.xml"/>
      <xi:include href="xml/ide-terminal-search.xml"/>
      <xi:include href="xml/ide-terminal-surface.xml"/>
      <xi:include href="xml/ide-terminal-util.xml"/>
      <xi:include href="xml/ide-terminal-workspace.xml"/>
      <xi:include href="xml/ide-terminal.xml"/>
    </chapter>

    <chapter>
      <title>Debugging</title>
      <xi:include href="xml/ide-debugger-address-map-private.xml"/>
      <xi:include href="xml/ide-debugger-breakpoints.xml"/>
      <xi:include href="xml/ide-debugger-breakpoint.xml"/>
      <xi:include href="xml/ide-debugger-frame.xml"/>
      <xi:include href="xml/ide-debugger-instruction.xml"/>
      <xi:include href="xml/ide-debugger-library.xml"/>
      <xi:include href="xml/ide-debugger-register.xml"/>
      <xi:include href="xml/ide-debugger-thread-group.xml"/>
      <xi:include href="xml/ide-debugger-thread.xml"/>
      <xi:include href="xml/ide-debugger-types.xml"/>
      <xi:include href="xml/ide-debugger-variable.xml"/>
      <xi:include href="xml/ide-debugger.xml"/>
      <xi:include href="xml/ide-debug-manager.xml"/>
    </chapter>

    <chapter>
      <title>Language Servers</title>
      <xi:include href="xml/ide-lsp-client.xml"/>
      <xi:include href="xml/ide-lsp-completion-item.xml"/>
      <xi:include href="xml/ide-lsp-completion-provider.xml"/>
      <xi:include href="xml/ide-lsp-completion-results.xml"/>
      <xi:include href="xml/ide-lsp-diagnostic-provider.xml"/>
      <xi:include href="xml/ide-lsp-formatter.xml"/>
      <xi:include href="xml/ide-lsp-highlighter.xml"/>
      <xi:include href="xml/ide-lsp-hover-provider.xml"/>
      <xi:include href="xml/ide-lsp-rename-provider.xml"/>
      <xi:include href="xml/ide-lsp-symbol-node-private.xml"/>
      <xi:include href="xml/ide-lsp-symbol-node.xml"/>
      <xi:include href="xml/ide-lsp-symbol-resolver.xml"/>
      <xi:include href="xml/ide-lsp-symbol-tree-private.xml"/>
      <xi:include href="xml/ide-lsp-symbol-tree.xml"/>
      <xi:include href="xml/ide-lsp-types.xml"/>
      <xi:include href="xml/ide-lsp-util.xml"/>
    </chapter>

  </part>

  <chapter id="object-tree">
    <title>Object Hierarchy</title>
    <xi:include href="xml/tree_index.sgml"/>
  </chapter>

  <index id="api-index-full">
    <title>API Index</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  </index>

  <index id="deprecated-api-index" role="deprecated">
    <title>Index of deprecated API</title>
    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
  </index>

  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>

  <chapter id="legal">
    <title>Copyright and Legal Information</title>

    <para>
      This document is the API reference for for &package_name; &package_version;.
      The latest version of this API reference is also available
      <ulink role="online-location" url="https://developer.gnome.org/libide/">online</ulink>.
    </para>
    <para>
      If you find any issues in this API reference, please report it
      using <ulink type="http" url="&package_bugreport;">the online
      bug reporting tool</ulink> at bugzilla.gnome.org.
    </para>

    <para>Copyright © 2014-2017 Christian Hergert, et al.</para>

    <para>
      Permission is granted to copy, distribute and/or modify this document
      under the terms of the <citetitle>GNU Free Documentation
        License</citetitle>, Version 1.1 or any later version published by the
      Free Software Foundation with no Invariant Sections, no Front-Cover
      Texts, and no Back-Cover Texts. You may obtain a copy of the
      <citetitle>GNU Free Documentation License</citetitle> from the Free
      Software Foundation by visiting <ulink type="http"
        url="http://www.fsf.org">their Web site</ulink> or by writing to:

      <address>
        The Free Software Foundation, Inc.,
        <street>59 Temple Place</street> - Suite 330,
        <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
        <country>USA</country>
      </address>
    </para>
  </chapter>
</book>
