cs_xref_fwd.hpp

Go to the documentation of this file.

/*
 *      Copyright (c) 2023, an unpublished work by CodeSecure, Inc.
 *                      ALL RIGHTS RESERVED
 *
 *      Copyright (c) 2013-2023, an unpublished work by GrammaTech, Inc.
 *                      ALL RIGHTS RESERVED
 *
 *      This software is furnished under a license and may be used and
 *      copied only in accordance with the terms of such license and the
 *      inclusion of the above copyright notice.  This software or any
 *      other copies thereof may not be provided or otherwise made
 *      available to any other person.  Title to and ownership of the
 *      software is retained by CodeSecure, Inc.
 */

#ifndef CS_XREF_FWD_HPP
#define CS_XREF_FWD_HPP

#include "cs_enum_boilerplate.hpp"

#ifdef CSFE_API
#error --- frontend should not include this, 
#endif

#include "cs_xref.h"
#include "cs_types.hpp"
#include "cs_xr_kind_role.hpp"

namespace cs{

    class xr_tuple;

    class xr_def_iter_flags{
        CS_FLAGS_BOILERPLATE(xr_def_iter_flags, cs_xref_def_iter_flags, 
                             csxrdif_all,
                             "drop_libmodel_defs");
        static const xr_def_iter_flags NONE;              

        static const xr_def_iter_flags DROP_LIBMODEL_DEFS; 
    };
    CS_FLAGS_BOILERPLATE_FRIENDS(xr_def_iter_flags,
                                 friend class xr_definition_iterator_policy;
                                 friend class sfile;,
                                 cs
        )
#ifdef CS_CPP_IMPL
    const xr_def_iter_flags xr_def_iter_flags::NONE = xr_def_iter_flags(csxrdif_none);
    const xr_def_iter_flags xr_def_iter_flags::DROP_LIBMODEL_DEFS = xr_def_iter_flags(csxrdif_drop_libmodel_defs);
#endif

    class xr_occ_iter_flags{
        CS_FLAGS_BOILERPLATE(xr_occ_iter_flags, cs_xref_occ_iter_flags, 
                             csxroif_all,
                             "drop_libmodel_defs",
                             "drop_libmodel_occs",
                             "dontcare_complete",
                             "dontcare_def_or_complete",
                             "populate_counters");
        static const xr_occ_iter_flags NONE;   

        static const xr_occ_iter_flags DROP_LIBMODEL_DEFS; 

        static const xr_occ_iter_flags DROP_LIBMODEL_OCCS; 

        static const xr_occ_iter_flags DONTCARE_COMPLETE; 

        static const xr_occ_iter_flags DONTCARE_DEF_OR_COMPLETE;

        static const xr_occ_iter_flags POPULATE_COUNTERS;
    };
    CS_FLAGS_BOILERPLATE_FRIENDS(xr_occ_iter_flags,
                                 friend class xr_occurrence_iterator_policy;
                                 friend class xr_homonym_iterator_policy;
                                 friend class sfile;,
                                 cs
        )
#ifdef CS_CPP_IMPL
    const xr_occ_iter_flags xr_occ_iter_flags::NONE = xr_occ_iter_flags(csxroif_none);
    const xr_occ_iter_flags xr_occ_iter_flags::DROP_LIBMODEL_DEFS = xr_occ_iter_flags(csxroif_drop_libmodel_defs);
    const xr_occ_iter_flags xr_occ_iter_flags::DROP_LIBMODEL_OCCS = xr_occ_iter_flags(csxroif_drop_libmodel_occs);
    const xr_occ_iter_flags xr_occ_iter_flags::DONTCARE_COMPLETE = xr_occ_iter_flags(csxroif_dontcare_complete);
    const xr_occ_iter_flags xr_occ_iter_flags::DONTCARE_DEF_OR_COMPLETE = xr_occ_iter_flags(csxroif_dontcare_def_or_complete);
    const xr_occ_iter_flags xr_occ_iter_flags::POPULATE_COUNTERS = xr_occ_iter_flags(csxroif_populate_counters);
#endif


    class xr_query_flags{
        CS_FLAGS_BOILERPLATE(xr_query_flags, cs_xref_query_flags, 
                             csxrqf_all,
                             "uniquify", 
                             "populate_counters");
        static const xr_query_flags NONE;

        static const xr_query_flags UNIQUIFY;        

        static const xr_query_flags POPULATE_COUNTERS;   
    };
    CS_FLAGS_BOILERPLATE_FRIENDS(xr_query_flags,
                                 friend class xr_query_iterator_policy_container;
                                 friend class xr_query;,
                                 cs
        )
#ifdef CS_CPP_IMPL
    const xr_query_flags xr_query_flags::NONE = xr_query_flags(csxrqf_none);
    const xr_query_flags xr_query_flags::UNIQUIFY = xr_query_flags(csxrqf_uniquify);
    const xr_query_flags xr_query_flags::POPULATE_COUNTERS = xr_query_flags(csxrqf_populate_counters);
#endif

}

#endif /* CS_XREF_FWD_HPP */