apiset.h

/*++ Copyright (c) 2008 Microsoft Corporation Module Name: apiset.h Abstract: This module contains definitions related to the management of API namespaces. Author: Arun Kishan (arunki) 14-Sep-2008 --*/

#ifndef _API_SET_H_

#define _API_SET_H_

// API set interface definitions.

#define API_SET_OVERRIDE(X) X##Implementation

#define API_SET_LEGACY_OVERRIDE_DEF(X) X = API_SET_OVERRIDE(X)

#define API_SET_OVERRIDE_DEF(X) API_SET_LEGACY_OVERRIDE_DEF(X) PRIVATE

#ifdef _M_HYBRID_X86_ARM64

#define API_SET_CHPE_GUEST X86

#else

#define API_SET_CHPE_GUEST

#endif

#ifdef _API_SET_HOST

// This section is intended for hosting contracts. Any legacy host definitions are ignored.

#undef API_SET_LIBRARY

#define API_SET_LIBRARY(X)

#undef API_SET

#undef API_SET_DIR

#undef API_SET_PRIVATE

#undef API_SET_PRIVATE_DIR

#undef API_SET_BY_ORDINAL

#undef API_SET_BY_ORDINAL_DIR

#undef API_SET_BY_ORDINAL_PRIVATE

#undef API_SET_BY_ORDINAL_PRIVATE_DIR

#undef API_SET_LEGACY

#undef API_SET_LEGACY_DIR

#undef API_SET_LEGACY_PRIVATE

#undef API_SET_LEGACY_PRIVATE_DIR

#undef API_SET_LEGACY_BY_ORDINAL

#undef API_SET_LEGACY_BY_ORDINAL_DIR

#undef API_SET_LEGACY_BY_ORDINAL_PRIVATE

#undef API_SET_LEGACY_BY_ORDINAL_PRIVATE_DIR

#define API_SET(X) X PRIVATE

#define API_SET_DIR(X,DIR) X DIR PRIVATE

#define API_SET_PRIVATE(X) X PRIVATE

#define API_SET_PRIVATE_DIR(X, DIR) X DIR PRIVATE

#define API_SET_BY_ORDINAL(X,O,PO) X @##O NONAME PRIVATE

#define API_SET_BY_ORDINAL_DIR(X,O,PO,DIR) X @##O NONAME DIR PRIVATE

#define API_SET_BY_ORDINAL_PRIVATE(X,O,PO) X @##O NONAME PRIVATE

#define API_SET_BY_ORDINAL_PRIVATE_DIR(X,O,PO,DIR) X @##O NONAME DIR PRIVATE

#define API_SET_LEGACY(X,L) X PRIVATE

#define API_SET_LEGACY_DIR(X,L,DIR) X DIR PRIVATE

#define API_SET_LEGACY_PRIVATE(X,L) X PRIVATE

#define API_SET_LEGACY_PRIVATE_DIR(X,L,DIR) X DIR PRIVATE

#define API_SET_LEGACY_BY_ORDINAL(X,L,O,PO) X @##O NONAME PRIVATE

#define API_SET_LEGACY_BY_ORDINAL_DIR(X,L,O,PO,DIR) X @##O NONAME DIR PRIVATE

#define API_SET_LEGACY_BY_ORDINAL_PRIVATE(X,L,O,PO) X @##O NONAME PRIVATE

#define API_SET_LEGACY_BY_ORDINAL_PRIVATE_DIR(X,L,O,PO,DIR) X @##O NONAME DIR PRIVATE

#else

#if defined(_API_SET_LEGACY_TARGET)

// This section is intended for "classic apiset forwarders" that are forwarding back to a legacy host.

// In this section, the definition for _API_SET_LEGACY_TARGET is taken as the default legacy host for the

// entire contract. But any APIs which specify LegacyHost directly will override this definition.

#define API_SET(X) X = _API_SET_LEGACY_TARGET##.##X

#define API_SET_DIR(X,DIR) X = _API_SET_LEGACY_TARGET##.##X DIR

#define API_SET_PRIVATE(X) X = _API_SET_LEGACY_TARGET##.##X PRIVATE

#define API_SET_PRIVATE_DIR(X,DIR) X = _API_SET_LEGACY_TARGET##.##X DIR PRIVATE

#define API_SET_BY_ORDINAL(X,O,PO) X = _API_SET_LEGACY_TARGET##.##PO @##O NONAME

#define API_SET_BY_ORDINAL_DIR(X,O,PO,DIR) X = _API_SET_LEGACY_TARGET##.##PO @##O NONAME DIR

#define API_SET_BY_ORDINAL_PRIVATE(X,O,PO) X = _API_SET_LEGACY_TARGET##.##PO @##O NONAME PRIVATE

#define API_SET_BY_ORDINAL_PRIVATE_DIR(X,O,PO,DIR) X = _API_SET_LEGACY_TARGET##.##PO @##O NONAME DIR PRIVATE

#define API_SET_LEGACY(X,L) X = L##.##X

#define API_SET_LEGACY_DIR(X,L,DIR) X = L##.##X DIR

#define API_SET_LEGACY_PRIVATE(X,L) X = L##.##X PRIVATE

#define API_SET_LEGACY_PRIVATE_DIR(X,L,DIR) X = L##.##X DIR PRIVATE

#define API_SET_LEGACY_BY_ORDINAL(X,L,O,PO) X = L##.##PO @##O NONAME

#define API_SET_LEGACY_BY_ORDINAL_DIR(X,L,O,PO,DIR) X = L##.##PO @##O NONAME DIR

#define API_SET_LEGACY_BY_ORDINAL_PRIVATE(X,L,O,PO) X = L##.##PO @##O NONAME PRIVATE

#define API_SET_LEGACY_BY_ORDINAL_PRIVATE_DIR(X,L,O,PO,DIR) X = L##.##PO @##O NONAME DIR PRIVATE

#elif defined(_API_SET_FORWARDER_TARGET)

// This section is intended for "reverse forwarders" that are forwarding to an explicit apiset name.

// Any legacy targets are ignored.

#define API_SET(X) X = _API_SET_FORWARDER_TARGET##.##X

#define API_SET_DIR(X,DIR) X = _API_SET_FORWARDER_TARGET##.##X DIR

#define API_SET_PRIVATE(X) X = _API_SET_FORWARDER_TARGET##.##X PRIVATE

#define API_SET_PRIVATE_DIR(X,DIR) X = _API_SET_FORWARDER_TARGET##.##X DIR PRIVATE

#define API_SET_BY_ORDINAL(X,O,PO) X = _API_SET_FORWARDER_TARGET##.##PO @##O NONAME

#define API_SET_BY_ORDINAL_DIR(X,O,PO,DIR) X = _API_SET_FORWARDER_TARGET##.##PO @##O NONAME DIR

#define API_SET_BY_ORDINAL_PRIVATE(X,O,PO) X = _API_SET_FORWARDER_TARGET##.##PO @##O NONAME PRIVATE

#define API_SET_BY_ORDINAL_PRIVATE_DIR(X,O,PO,DIR) X = _API_SET_FORWARDER_TARGET##.##PO @##O NONAME DIR PRIVATE

#define API_SET_LEGACY(X,L) X = _API_SET_FORWARDER_TARGET##.##X

#define API_SET_LEGACY_DIR(X,L,DIR) X = _API_SET_FORWARDER_TARGET##.##X DIR

#define API_SET_LEGACY_PRIVATE(X,L) X = _API_SET_FORWARDER_TARGET##.##X PRIVATE

#define API_SET_LEGACY_PRIVATE_DIR(X,L,DIR) X = _API_SET_FORWARDER_TARGET##.##X DIR PRIVATE

#define API_SET_LEGACY_BY_ORDINAL(X,L,O,PO) X = _API_SET_FORWARDER_TARGET##.##PO @##O NONAME

#define API_SET_LEGACY_BY_ORDINAL_DIR(X,L,O,PO,DIR) X = _API_SET_FORWARDER_TARGET##.##PO @##O NONAME DIR

#define API_SET_LEGACY_BY_ORDINAL_PRIVATE(X,L,O,PO) X = _API_SET_FORWARDER_TARGET##.##PO @##O NONAME PRIVATE

#define API_SET_LEGACY_BY_ORDINAL_PRIVATE_DIR(X,L,O,PO,DIR) X = _API_SET_FORWARDER_TARGET##.##PO @##O NONAME DIR PRIVATE

#else

// This section is intended for internal contract generation to build artifacts that model the contract without forwarding.

#define API_SET(X) X

#define API_SET_DIR(X,DIR) X DIR

#define API_SET_PRIVATE(X) X PRIVATE

#define API_SET_PRIVATE_DIR(X,DIR) X DIR PRIVATE

#define API_SET_BY_ORDINAL(X,O,PO) X @##O NONAME

#define API_SET_BY_ORDINAL_DIR(X,O,PO,DIR) X @##O NONAME DIR

#define API_SET_BY_ORDINAL_PRIVATE(X,O,PO) X @##O NONAME PRIVATE

#define API_SET_BY_ORDINAL_PRIVATE_DIR(X,O,PO,DIR) X @##O NONAME DIR PRIVATE

#define API_SET_LEGACY(X,L) X

#define API_SET_LEGACY_DIR(X,L,DIR) X DIR

#define API_SET_LEGACY_PRIVATE(X,L) X PRIVATE

#define API_SET_LEGACY_PRIVATE_DIR(X,L,DIR) X DIR PRIVATE

#define API_SET_LEGACY_BY_ORDINAL(X,L,O,PO) X @##O NONAME

#define API_SET_LEGACY_BY_ORDINAL_DIR(X,L,O,PO,DIR) X @##O NONAME DIR

#define API_SET_LEGACY_BY_ORDINAL_PRIVATE(X,L,O,PO) X @##O NONAME PRIVATE

#define API_SET_LEGACY_BY_ORDINAL_PRIVATE_DIR(X,L,O,PO,DIR) X @##O NONAME DIR PRIVATE

#endif // _API_SET_LEGACY_TARGET, _API_SET_FORWARDER_TARGET

#define API_SET_LIBRARY(X) LIBRARY X

#endif // _API_SET_HOST

#endif // _API_SET_H_