.. _Content Filters Examples:

Content Filters Examples
========================

.. code-block:: xml
    :caption: Hide the Types, Tasks and Problems from a library

    <filter kind="HIDE" name="Base classes">
        <description>Hide the Types, Tasks and Problems from /path/to/my_base_classes</description>
        <view-set match="TRUE">
            <view name="TYPES" />
            <view name="TASKS" />
            <view name="PROBLEMS" />
        </view-set>
        <path-set match="TRUE">
            <path pattern="/path/to/my_base_classes/*" />
        </path-set>
    </filter>

.. code-block:: xml
    :caption: Hide the Tasks and Problems from a library

    <filter kind="HIDE" name="My library">
        <description>Hide the Tasks and Problems from files included by my_library_top.svh</description>
        <view-set match="TRUE">
            <view name="TASKS" />
            <view name="PROBLEMS" />
        </view-set>
        <path-set match="TRUE">
            <path include-children="TRUE" pattern="*/my_library_top.svh" />
        </path-set>
    </filter>

.. code-block:: xml
    :caption: Hide from Outline View the functions and fields introduced by specific macros

    <filter kind="HIDE" name="Noisy macros">
        <description>Hide from Outline View the functions and fields introduced by macros defined in files under $MY_MACROS_LIBRARY</description>
        <view-set match="TRUE">
            <view name="OUTLINE" />
        </view-set>
        <path-set apply-to-macro-call-stack="TRUE" match="TRUE">
            <path pattern="$MY_MACROS_LIBRARY/*" />
        </path-set>
        <element-type-set match="TRUE">
            <element-type name="FUNCTION"/>
            <element-type name="FIELD"/>
        </element-type-set>
    </filter>

.. code-block:: xml
    :caption: See only tasks that contain REVIEW_FIRST from a library

    <filter kind="HIDE" name="REVIEW_FIRST tasks">
        <description>Hide the tasks that don't contain REVIEW_FIRST from /path/to/my_in_progress_folder</description>
        <view-set match="TRUE">
            <view name="TASKS" />
        </view-set>
        <path-set match="TRUE">
            <path pattern="/path/to/my_in_progress_folder/*" />
        </path-set>
        <element-text-set match="FALSE">
            <element-text pattern="*REVIEW_FIRST*"/>
        </element-text-set>
    </filter>

.. code-block:: xml
    :caption: See only macros and types from precompiled files

    <filter kind="HIDE" name="Precompiled Databases">
        <description>Hide the types and macros from precompiled files</description>
        <view-set match="TRUE">
            <view name="TYPES" />
            <view name="MACRO" />
        </view-set>
        <path-set match="TRUE">
            <path pattern="*" />
        </path-set>
        <precompiled-element match="TRUE"/>
    </filter>