Skip to content
This repository has been archived by the owner on Apr 2, 2020. It is now read-only.

Latest commit

 

History

History
81 lines (58 loc) · 2.68 KB

include_projects.rst

File metadata and controls

81 lines (58 loc) · 2.68 KB
Raw

Defining Include Projects

Include projects allow you to specify a set of C# files and / or other resources which should be included in projects that reference the include project. This allows libraries to include additional code or resources into executables that use them.

For example, a library may provide a default main entry point for programs using that library, so that the developer does not have to manually configure application start up (unless they want to). The library can define an include project which is then pulled in by the application so that the main entry point class is defined in the correct (executable) assembly.

Project structure

A simple example of an include project definition is shown below.

.. literalinclude:: example/include_demo.xml
    :language: xml

Including files

Declaring files for inclusion in an include project uses the exact same structure used in application, console and library projects, including the ability to declare files for specific platforms or services.

See :ref:`declaring-files` for documentation on how to declare files in a project.

Referencing include projects

Referencing include projects works like any other Protobuild project, either from an application, console or library project:

.. literalinclude:: example/include_reference.xml
    :language: xml
    :emphasize-lines: 6

or from an external project:

.. literalinclude:: example/include_externalreference.xml
    :language: xml
    :emphasize-lines: 5

Apply include projects as extensions

Rather than declare an include project as a reference in a normal project, you can also use the AppliesTo attribute on the include project to specify that it should be applied to another project.

This allows you to define include projects that works as extensions - extending the functionality of another project that is not aware of your include project.

You can set the AppliesTo attribute on the IncludeProject node, like so:

.. literalinclude:: example/include_appliesto.xml
    :language: xml
    :emphasize-lines: 2

Limiting platforms

If you have an include project that you only want to apply when certain platforms are being generated for, you can use the Platforms attribute to restrict what platforms this include project is included for.

An example of using the Platforms attribute to restrict when an include project is included can be seen below.

.. literalinclude:: example/include_exclude_platforms.xml
    :language: xml
    :emphasize-lines: 2