#ifndef SLANG_H

#define SLANG_H

/** \file slang.h

The Slang API provides services to compile, reflect, and specialize code

written in the Slang shading language.

*/

/*

The following section attempts to detect the compiler and version in use.

If an application defines `SLANG_COMPILER` before including this header,

they take responsibility for setting any compiler-dependent macros

used later in the file.

Most applications should not need to touch this section.

*/

#ifndef SLANG_COMPILER

# define SLANG_COMPILER

/*

Compiler defines, see http://sourceforge.net/p/predef/wiki/Compilers/

NOTE that SLANG_VC holds the compiler version - not just 1 or 0

*/

# if defined(_MSC_VER)

# if _MSC_VER >= 1900

# define SLANG_VC 14

# elif _MSC_VER >= 1800

# define SLANG_VC 12

# elif _MSC_VER >= 1700

# define SLANG_VC 11

# elif _MSC_VER >= 1600

# define SLANG_VC 10

# elif _MSC_VER >= 1500

# define SLANG_VC 9

# else

# error "unknown version of Visual C++ compiler"

# endif

# elif defined(__clang__)

# define SLANG_CLANG 1

# elif defined(__SNC__)

# define SLANG_SNC 1

# elif defined(__ghs__)

# define SLANG_GHS 1

# elif defined(__GNUC__) /* note: __clang__, __SNC__, or __ghs__ imply __GNUC__ */

# define SLANG_GCC 1

# else

# error "unknown compiler"

# endif

/*

Any compilers not detected by the above logic are now now explicitly zeroed out.

*/

# ifndef SLANG_VC

# define SLANG_VC 0

# endif

# ifndef SLANG_CLANG

# define SLANG_CLANG 0

# endif

# ifndef SLANG_SNC

# define SLANG_SNC 0

# endif

# ifndef SLANG_GHS

# define SLANG_GHS 0

# endif

# ifndef SLANG_GCC

# define SLANG_GCC 0

# endif

#endif /* SLANG_COMPILER */

/*

The following section attempts to detect the target platform being compiled for.

If an application defines `SLANG_PLATFORM` before including this header,

they take responsibility for setting any compiler-dependent macros

used later in the file.

Most applications should not need to touch this section.

*/

#ifndef SLANG_PLATFORM

# define SLANG_PLATFORM

/**

Operating system defines, see http://sourceforge.net/p/predef/wiki/OperatingSystems/

*/

# if defined(WINAPI_FAMILY) && WINAPI_FAMILY == WINAPI_PARTITION_APP

# define SLANG_WINRT 1 /* Windows Runtime, either on Windows RT or Windows 8 */

# elif defined(XBOXONE)

# define SLANG_XBOXONE 1

# elif defined(_WIN64) /* note: XBOXONE implies _WIN64 */

# define SLANG_WIN64 1

# elif defined(_M_PPC)

# define SLANG_X360 1

# elif defined(_WIN32) /* note: _M_PPC implies _WIN32 */

# define SLANG_WIN32 1

# elif defined(__ANDROID__)

# define SLANG_ANDROID 1

# elif defined(__linux__) || defined(__CYGWIN__) /* note: __ANDROID__ implies __linux__ */

# define SLANG_LINUX 1

# elif defined(__APPLE__) && (defined(__arm__) || defined(__arm64__))

# define SLANG_IOS 1

# elif defined(__APPLE__)

# define SLANG_OSX 1

# elif defined(__CELLOS_LV2__)

# define SLANG_PS3 1

# elif defined(__ORBIS__)

# define SLANG_PS4 1

# elif defined(__SNC__) && defined(__arm__)

# define SLANG_PSP2 1

# elif defined(__ghs__)

# define SLANG_WIIU 1

# else

# error "unknown target platform"

# endif

/*

Any platforms not detected by the above logic are now now explicitly zeroed out.

*/

# ifndef SLANG_WINRT

# define SLANG_WINRT 0

# endif

# ifndef SLANG_XBOXONE

# define SLANG_XBOXONE 0

# endif

# ifndef SLANG_WIN64

# define SLANG_WIN64 0

# endif

# ifndef SLANG_X360

# define SLANG_X360 0

# endif

# ifndef SLANG_WIN32

# define SLANG_WIN32 0

# endif

# ifndef SLANG_ANDROID

# define SLANG_ANDROID 0

# endif

# ifndef SLANG_LINUX

# define SLANG_LINUX 0

# endif

# ifndef SLANG_IOS

# define SLANG_IOS 0

# endif

# ifndef SLANG_OSX

# define SLANG_OSX 0

# endif

# ifndef SLANG_PS3

# define SLANG_PS3 0

# endif

# ifndef SLANG_PS4

# define SLANG_PS4 0

# endif

# ifndef SLANG_PSP2

# define SLANG_PSP2 0

# endif

# ifndef SLANG_WIIU

# define SLANG_WIIU 0

# endif

#endif /* SLANG_PLATFORM */

/* Shorthands for "families" of compilers/platforms */

#define SLANG_GCC_FAMILY (SLANG_CLANG || SLANG_SNC || SLANG_GHS || SLANG_GCC)

#define SLANG_WINDOWS_FAMILY (SLANG_WINRT || SLANG_WIN32 || SLANG_WIN64)

#define SLANG_MICROSOFT_FAMILY (SLANG_XBOXONE || SLANG_X360 || SLANG_WINDOWS_FAMILY)

#define SLANG_LINUX_FAMILY (SLANG_LINUX || SLANG_ANDROID)

#define SLANG_APPLE_FAMILY (SLANG_IOS || SLANG_OSX) /* equivalent to #if __APPLE__ */

#define SLANG_UNIX_FAMILY (SLANG_LINUX_FAMILY || SLANG_APPLE_FAMILY) /* shortcut for unix/posix platforms */

/* Macro for declaring if a method is no throw. Should be set before the return parameter. */

#ifndef SLANG_NO_THROW

# if SLANG_WINDOWS_FAMILY && !defined(SLANG_DISABLE_EXCEPTIONS)

# define SLANG_NO_THROW __declspec(nothrow)

# endif

#endif

#ifndef SLANG_NO_THROW

# define SLANG_NO_THROW

#endif

/* The `SLANG_STDCALL` and `SLANG_MCALL` defines are used to set the calling

convention for interface methods.

*/

#ifndef SLANG_STDCALL

# if SLANG_MICROSOFT_FAMILY

# define SLANG_STDCALL __stdcall

# else

# define SLANG_STDCALL

# endif

#endif

#ifndef SLANG_MCALL

# define SLANG_MCALL SLANG_STDCALL

#endif

#if !defined(SLANG_STATIC) && !defined(SLANG_STATIC)

#define SLANG_DYNAMIC

#endif

#if defined(_MSC_VER)

# define SLANG_DLL_EXPORT __declspec(dllexport)

#else

# if 0 && __GNUC__ >= 4

// Didn't work on latest gcc on linux.. so disable for now

// https://gcc.gnu.org/wiki/Visibility

# define SLANG_DLL_EXPORT __attribute__ ((dllexport))

# else

# define SLANG_DLL_EXPORT __attribute__((__visibility__("default")))

# endif

#endif

#if defined(SLANG_DYNAMIC)

# if defined(_MSC_VER)

# ifdef SLANG_DYNAMIC_EXPORT

# define SLANG_API SLANG_DLL_EXPORT

# else

# define SLANG_API __declspec(dllimport)

# endif

# else

// TODO: need to consider compiler capabilities

//# ifdef SLANG_DYNAMIC_EXPORT

# define SLANG_API SLANG_DLL_EXPORT

//# endif

# endif

#endif

#ifndef SLANG_API

# define SLANG_API

#endif

// GCC Specific

#if SLANG_GCC_FAMILY

// This doesn't work on clang - because the typedef is seen as multiply defined, use the line numbered version defined later

# if !defined(__clang__) && (defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7)) || defined(__ORBIS__))

# define SLANG_COMPILE_TIME_ASSERT(exp) typedef char SlangCompileTimeAssert_Dummy[(exp) ? 1 : -1] __attribute__((unused))

# endif

# define SLANG_NO_INLINE __attribute__((noinline))

# define SLANG_FORCE_INLINE inline __attribute__((always_inline))

# define SLANG_BREAKPOINT(id) __builtin_trap();

# define SLANG_ALIGN_OF(T) __alignof__(T)

// Use this macro instead of offsetof, because gcc produces warning if offsetof is used on a

// non POD type, even though it produces the correct result

# define SLANG_OFFSET_OF(T, ELEMENT) (size_t(&((T*)1)->ELEMENT) - 1)

#endif // SLANG_GCC_FAMILY

// Microsoft VC specific

#if SLANG_MICROSOFT_FAMILY

# define SLANG_NO_INLINE __declspec(noinline)

# define SLANG_FORCE_INLINE __forceinline

# define SLANG_BREAKPOINT(id) __debugbreak();

# define SLANG_ALIGN_OF(T) __alignof(T)

# define SLANG_INT64(x) (x##i64)

# define SLANG_UINT64(x) (x##ui64)

#endif // SLANG_MICROSOFT_FAMILY

#ifndef SLANG_FORCE_INLINE

# define SLANG_FORCE_INLINE inline

#endif

#ifndef SLANG_NO_INLINE

# define SLANG_NO_INLINE

#endif

#ifndef SLANG_COMPILE_TIME_ASSERT

# define SLANG_COMPILE_TIME_ASSERT(exp) typedef char SLANG_CONCAT(SlangCompileTimeAssert,__LINE__)[(exp) ? 1 : -1]

#endif

#ifndef SLANG_OFFSET_OF

# define SLANG_OFFSET_OF(X, Y) offsetof(X, Y)

#endif

#ifndef SLANG_BREAKPOINT

// Make it crash with a write to 0!

# define SLANG_BREAKPOINT(id) (*((int*)0) = int(id));

#endif

// Use for getting the amount of members of a standard C array.

#define SLANG_COUNT_OF(x) (sizeof(x)/sizeof(x[0]))

/// SLANG_INLINE exists to have a way to inline consistent with SLANG_ALWAYS_INLINE

#define SLANG_INLINE inline

// Other defines

#define SLANG_STRINGIZE_HELPER(X) #X

#define SLANG_STRINGIZE(X) SLANG_STRINGIZE_HELPER(X)

#define SLANG_CONCAT_HELPER(X, Y) X##Y

#define SLANG_CONCAT(X, Y) SLANG_CONCAT_HELPER(X, Y)

#ifndef SLANG_UNUSED

# define SLANG_UNUSED(v) (void)v;

#endif

// Used for doing constant literals

#ifndef SLANG_INT64

# define SLANG_INT64(x) (x##ll)

#endif

#ifndef SLANG_UINT64

# define SLANG_UINT64(x) (x##ull)

#endif

#ifdef __cplusplus

# define SLANG_EXTERN_C extern "C"

#else

# define SLANG_EXTERN_C

#endif

#ifdef __cplusplus

// C++ specific macros

// Clang

#if SLANG_CLANG

# if (__clang_major__*10 + __clang_minor__) >= 33

# define SLANG_HAS_MOVE_SEMANTICS 1

# define SLANG_HAS_ENUM_CLASS 1

# define SLANG_OVERRIDE override

# endif

// Gcc

#elif SLANG_GCC_FAMILY

// Check for C++11

# if (__cplusplus >= 201103L)

# if (__GNUC__ * 100 + __GNUC_MINOR__) >= 405

# define SLANG_HAS_MOVE_SEMANTICS 1

# endif

# if (__GNUC__ * 100 + __GNUC_MINOR__) >= 406

# define SLANG_HAS_ENUM_CLASS 1

# endif

# if (__GNUC__ * 100 + __GNUC_MINOR__) >= 407

# define SLANG_OVERRIDE override

# endif

# endif

# endif // SLANG_GCC_FAMILY

// Visual Studio

# if SLANG_VC

// C4481: nonstandard extension used: override specifier 'override'

# if _MSC_VER < 1700

# pragma warning(disable : 4481)

# endif

# define SLANG_OVERRIDE override

# if _MSC_VER >= 1600

# define SLANG_HAS_MOVE_SEMANTICS 1

# endif

# if _MSC_VER >= 1700

# define SLANG_HAS_ENUM_CLASS 1

# endif

# endif // SLANG_VC

// Set non set

# ifndef SLANG_OVERRIDE

# define SLANG_OVERRIDE

# endif

# ifndef SLANG_HAS_ENUM_CLASS

# define SLANG_HAS_ENUM_CLASS 0

# endif

# ifndef SLANG_HAS_MOVE_SEMANTICS

# define SLANG_HAS_MOVE_SEMANTICS 0

# endif

#endif // __cplusplus

/* Macros for detecting processor */

#if defined(_M_ARM) || defined(__ARM_EABI__)

// This is special case for nVidia tegra

# define SLANG_PROCESSOR_ARM 1

#elif defined(__i386__) || defined(_M_IX86)

# define SLANG_PROCESSOR_X86 1

#elif defined(_M_AMD64) || defined(_M_X64) || defined(__amd64) || defined(__x86_64)

# define SLANG_PROCESSOR_X86_64 1

#elif defined(_PPC_) || defined(__ppc__) || defined(__POWERPC__) || defined(_M_PPC)

# if defined(__powerpc64__) || defined(__ppc64__) || defined(__PPC64__) || defined(__64BIT__) || defined(_LP64) || defined(__LP64__)

# define SLANG_PROCESSOR_POWER_PC_64 1

# else

# define SLANG_PROCESSOR_POWER_PC 1

# endif

#elif defined(__arm__)

# define SLANG_PROCESSOR_ARM 1

#elif defined(__aarch64__)

# define SLANG_PROCESSOR_ARM_64 1

#endif

#ifndef SLANG_PROCESSOR_ARM

# define SLANG_PROCESSOR_ARM 0

#endif

#ifndef SLANG_PROCESSOR_ARM_64

# define SLANG_PROCESSOR_ARM_64 0

#endif

#ifndef SLANG_PROCESSOR_X86

# define SLANG_PROCESSOR_X86 0

#endif

#ifndef SLANG_PROCESSOR_X86_64

# define SLANG_PROCESSOR_X86_64 0

#endif

#ifndef SLANG_PROCESSOR_POWER_PC

# define SLANG_PROCESSOR_POWER_PC 0

#endif

#ifndef SLANG_PROCESSOR_POWER_PC_64

# define SLANG_PROCESSOR_POWER_PC_64 0

#endif

// Processor families

#define SLANG_PROCESSOR_FAMILY_X86 (SLANG_PROCESSOR_X86_64 | SLANG_PROCESSOR_X86)

#define SLANG_PROCESSOR_FAMILY_ARM (SLANG_PROCESSOR_ARM | SLANG_PROCESSOR_ARM_64)

#define SLANG_PROCESSOR_FAMILY_POWER_PC (SLANG_PROCESSOR_POWER_PC_64 | SLANG_PROCESSOR_POWER_PC)

// Pointer size

#define SLANG_PTR_IS_64 (SLANG_PROCESSOR_ARM_64 | SLANG_PROCESSOR_X86_64 | SLANG_PROCESSOR_POWER_PC_64)

#define SLANG_PTR_IS_32 (SLANG_PTR_IS_64 ^ 1)

// Processor features

#if SLANG_PROCESSOR_FAMILY_X86

# define SLANG_LITTLE_ENDIAN 1

# define SLANG_UNALIGNED_ACCESS 1

#elif SLANG_PROCESSOR_FAMILY_ARM

# if defined(__ARMEB__)

# define SLANG_BIG_ENDIAN 1

# else

# define SLANG_LITTLE_ENDIAN 1

# endif

#elif SLANG_PROCESSOR_FAMILY_POWER_PC

# define SLANG_BIG_ENDIAN 1

#endif

#ifndef SLANG_LITTLE_ENDIAN

# define SLANG_LITTLE_ENDIAN 0

#endif

#ifndef SLANG_BIG_ENDIAN

# define SLANG_BIG_ENDIAN 0

#endif

#ifndef SLANG_UNALIGNED_ACCESS

# define SLANG_UNALIGNED_ACCESS 0

#endif

// One endianess must be set

#if ((SLANG_BIG_ENDIAN | SLANG_LITTLE_ENDIAN) == 0)

# error "Couldn't determine endianess"

#endif

#ifndef SLANG_NO_INTTYPES

#include <inttypes.h>

#endif // ! SLANG_NO_INTTYPES

#ifndef SLANG_NO_STDDEF

#include <stddef.h>

#endif // ! SLANG_NO_STDDEF

#ifdef __cplusplus

extern "C"

{

#endif

/*!

@mainpage Introduction

API Reference: slang.h

@file slang.h

*/

typedef uint32_t SlangUInt32;

typedef int32_t SlangInt32;

// Use SLANG_PTR_ macros to determine SlangInt/SlangUInt types.

// This is used over say using size_t/ptrdiff_t/intptr_t/uintptr_t, because on some targets, these types are distinct from

// their uint_t/int_t equivalents and so produce ambiguity with function overloading.

#if SLANG_PTR_IS_64

typedef int64_t SlangInt;

typedef uint64_t SlangUInt;

#else

typedef int32_t SlangInt;

typedef uint32_t SlangUInt;

#endif

typedef bool SlangBool;

/*!

@brief Severity of a diagnostic generated by the compiler.

Values come from the enum below, with higher values representing more severe

conditions, and all values >= SLANG_SEVERITY_ERROR indicating compilation

failure.

*/

typedef int SlangSeverity;

enum

{

SLANG_SEVERITY_NOTE = 0, /**< An informative message. */

SLANG_SEVERITY_WARNING, /**< A warning, which indicates a possible proble. */

SLANG_SEVERITY_ERROR, /**< An error, indicating that compilation failed. */

SLANG_SEVERITY_FATAL, /**< An unrecoverable error, which forced compilation to abort. */

SLANG_SEVERITY_INTERNAL, /**< An internal error, indicating a logic error in the compiler. */

};

typedef int SlangBindableResourceType;

enum

{

SLANG_NON_BINDABLE = 0,

SLANG_TEXTURE,

SLANG_SAMPLER,

SLANG_UNIFORM_BUFFER,

SLANG_STORAGE_BUFFER,

};

typedef int SlangCompileTarget;

enum

{

SLANG_TARGET_UNKNOWN,

SLANG_TARGET_NONE,

SLANG_GLSL,

SLANG_GLSL_VULKAN, //< deprecated: just use `SLANG_GLSL`

SLANG_GLSL_VULKAN_ONE_DESC, //< deprecated

SLANG_HLSL,

SLANG_SPIRV,

SLANG_SPIRV_ASM,

SLANG_DXBC,

SLANG_DXBC_ASM,

SLANG_DXIL,

SLANG_DXIL_ASM,

SLANG_C_SOURCE, ///< The C language

SLANG_CPP_SOURCE, ///< The C++ language

SLANG_EXECUTABLE, ///< Executable (for hosting CPU/OS)

SLANG_SHARED_LIBRARY, ///< A shared library/Dll (for hosting CPU/OS)

SLANG_HOST_CALLABLE, ///< A CPU target that makes the compiled code available to be run immediately

SLANG_CUDA_SOURCE, ///< Cuda source

SLANG_PTX, ///< PTX

SLANG_OBJECT_CODE, ///< Object code that can be used for later linking

SLANG_TARGET_COUNT_OF,

};

/* A "container format" describes the way that the outputs

for multiple files, entry points, targets, etc. should be

combined into a single artifact for output. */

typedef int SlangContainerFormat;

enum

{

/* Don't generate a container. */

SLANG_CONTAINER_FORMAT_NONE,

/* Generate a container in the `.slang-module` format,

which includes reflection information, compiled kernels, etc. */

SLANG_CONTAINER_FORMAT_SLANG_MODULE,

};

typedef int SlangPassThroughIntegral;

enum SlangPassThrough : SlangPassThroughIntegral

};

/* Defines an archive type used to holds a 'file system' type structure. */

typedef int SlangArchiveTypeIntegral;

enum SlangArchiveType : SlangArchiveTypeIntegral

};

/*!

Flags to control compilation behavior.

*/

typedef unsigned int SlangCompileFlags;

enum

{

/* Do as little mangling of names as possible, to try to preserve original names */

SLANG_COMPILE_FLAG_NO_MANGLING = 1 << 3,

/* Skip code generation step, just check the code and generate layout */

SLANG_COMPILE_FLAG_NO_CODEGEN = 1 << 4,

/* Obfuscate shader names on release products */

SLANG_COMPILE_FLAG_OBFUSCATE = 1 << 5,

/* Deprecated flags: kept around to allow existing applications to

compile. Note that the relevant features will still be left in

their default state. */

SLANG_COMPILE_FLAG_NO_CHECKING = 0,

SLANG_COMPILE_FLAG_SPLIT_MIXED_TYPES = 0,

};

/*!

@brief Flags to control code generation behavior of a compilation target */

typedef unsigned int SlangTargetFlags;

enum

{

/* When compiling for a D3D Shader Model 5.1 or higher target, allocate

distinct register spaces for parameter blocks.

@deprecated This behavior is now enabled unconditionally.

*/

SLANG_TARGET_FLAG_PARAMETER_BLOCKS_USE_REGISTER_SPACES = 1 << 4,

/* When set, will generate target code that contains all entrypoints defined

in the input source or specified via the `spAddEntryPoint` function in a

single output module (library/source file).

*/

SLANG_TARGET_FLAG_GENERATE_WHOLE_PROGRAM = 1 << 8,

/* When set, will dump out the IR between intermediate compilation steps.*/

SLANG_TARGET_FLAG_DUMP_IR = 1 << 9,

/* When set, will generate SPIRV directly instead of going through glslang. */

SLANG_TARGET_FLAG_GENERATE_SPIRV_DIRECTLY = 1 << 10,

};

/*!

@brief Options to control floating-point precision guarantees for a target.

*/

typedef unsigned int SlangFloatingPointMode;

enum

{

SLANG_FLOATING_POINT_MODE_DEFAULT = 0,

SLANG_FLOATING_POINT_MODE_FAST,

SLANG_FLOATING_POINT_MODE_PRECISE,

};

/*!

@brief Options to control emission of `#line` directives

*/

typedef unsigned int SlangLineDirectiveMode;

enum

{

SLANG_LINE_DIRECTIVE_MODE_DEFAULT = 0, /**< Default behavior: pick behavior base on target. */

SLANG_LINE_DIRECTIVE_MODE_NONE, /**< Don't emit line directives at all. */

SLANG_LINE_DIRECTIVE_MODE_STANDARD, /**< Emit standard C-style `#line` directives. */

SLANG_LINE_DIRECTIVE_MODE_GLSL, /**< Emit GLSL-style directives with file *number* instead of name */

};

typedef int SlangSourceLanguageIntegral;

enum SlangSourceLanguage : SlangSourceLanguageIntegral

};

typedef unsigned int SlangProfileID;

enum

{

SLANG_PROFILE_UNKNOWN,

};

typedef SlangInt32 SlangCapabilityID;

enum

{

SLANG_CAPABILITY_UNKNOWN = 0,

};

typedef unsigned int SlangMatrixLayoutMode;

enum

{

SLANG_MATRIX_LAYOUT_MODE_UNKNOWN = 0,

SLANG_MATRIX_LAYOUT_ROW_MAJOR,

SLANG_MATRIX_LAYOUT_COLUMN_MAJOR,

};

typedef SlangUInt32 SlangStage;

enum

{

SLANG_STAGE_NONE,

SLANG_STAGE_VERTEX,

SLANG_STAGE_HULL,

SLANG_STAGE_DOMAIN,

SLANG_STAGE_GEOMETRY,

SLANG_STAGE_FRAGMENT,

SLANG_STAGE_COMPUTE,

SLANG_STAGE_RAY_GENERATION,

SLANG_STAGE_INTERSECTION,

SLANG_STAGE_ANY_HIT,

SLANG_STAGE_CLOSEST_HIT,

SLANG_STAGE_MISS,

SLANG_STAGE_CALLABLE,

SLANG_STAGE_MESH,

SLANG_STAGE_AMPLIFICATION,

// alias:

SLANG_STAGE_PIXEL = SLANG_STAGE_FRAGMENT,

};

typedef SlangUInt32 SlangDebugInfoLevel;

enum

{

SLANG_DEBUG_INFO_LEVEL_NONE = 0, /**< Don't emit debug information at all. */

SLANG_DEBUG_INFO_LEVEL_MINIMAL, /**< Emit as little debug information as possible, while still supporting stack trackes. */

SLANG_DEBUG_INFO_LEVEL_STANDARD, /**< Emit whatever is the standard level of debug information for each target. */

SLANG_DEBUG_INFO_LEVEL_MAXIMAL, /**< Emit as much debug infromation as possible for each target. */

};

typedef SlangUInt32 SlangOptimizationLevel;

enum

{

SLANG_OPTIMIZATION_LEVEL_NONE = 0, /**< Don't optimize at all. */

SLANG_OPTIMIZATION_LEVEL_DEFAULT, /**< Default optimization level: balance code quality and compilation time. */

SLANG_OPTIMIZATION_LEVEL_HIGH, /**< Optimize aggressively. */

SLANG_OPTIMIZATION_LEVEL_MAXIMAL, /**< Include optimizations that may take a very long time, or may involve severe space-vs-speed tradeoffs */

};

/** A result code for a Slang API operation.

This type is generally compatible with the Windows API `HRESULT` type. In particular, negative values indicate

failure results, while zero or positive results indicate success.

In general, Slang APIs always return a zero result on success, unless documented otherwise. Strictly speaking

a negative value indicates an error, a positive (or 0) value indicates success. This can be tested for with the macros

SLANG_SUCCEEDED(x) or SLANG_FAILED(x).

It can represent if the call was successful or not. It can also specify in an extensible manner what facility

produced the result (as the integral 'facility') as well as what caused it (as an integral 'code').

Under the covers SlangResult is represented as a int32_t.

SlangResult is designed to be compatible with COM HRESULT.

It's layout in bits is as follows

Severity | Facility | Code

---------|----------|-----

31 | 30-16 | 15-0

Severity - 1 fail, 0 is success - as SlangResult is signed 32 bits, means negative number indicates failure.

Facility is where the error originated from. Code is the code specific to the facility.

Result codes have the following styles,

1) SLANG_name

2) SLANG_s_f_name

3) SLANG_s_name

where s is S for success, E for error

f is the short version of the facility name

Style 1 is reserved for SLANG_OK and SLANG_FAIL as they are so commonly used.

It is acceptable to expand 'f' to a longer name to differentiate a name or drop if unique without it.

ie for a facility 'DRIVER' it might make sense to have an error of the form SLANG_E_DRIVER_OUT_OF_MEMORY

*/

typedef int32_t SlangResult;

//! Use to test if a result was failure. Never use result != SLANG_OK to test for failure, as there may be successful codes != SLANG_OK.

#define SLANG_FAILED(status) ((status) < 0)

//! Use to test if a result succeeded. Never use result == SLANG_OK to test for success, as will detect other successful codes as a failure.

#define SLANG_SUCCEEDED(status) ((status) >= 0)

//! Get the facility the result is associated with

#define SLANG_GET_RESULT_FACILITY(r) ((int32_t)(((r) >> 16) & 0x7fff))

//! Get the result code for the facility

#define SLANG_GET_RESULT_CODE(r) ((int32_t)((r) & 0xffff))

#define SLANG_MAKE_ERROR(fac, code) ((((int32_t)(fac)) << 16) | ((int32_t)(code)) | int32_t(0x80000000))

#define SLANG_MAKE_SUCCESS(fac, code) ((((int32_t)(fac)) << 16) | ((int32_t)(code)))

/*************************** Facilities ************************************/

//! Facilities compatible with windows COM - only use if known code is compatible

#define SLANG_FACILITY_WIN_GENERAL 0

#define SLANG_FACILITY_WIN_INTERFACE 4

#define SLANG_FACILITY_WIN_API 7

//! Base facility -> so as to not clash with HRESULT values (values in 0x200 range do not appear used)

#define SLANG_FACILITY_BASE 0x200

/*! Facilities numbers must be unique across a project to make the resulting result a unique number.

It can be useful to have a consistent short name for a facility, as used in the name prefix */

#define SLANG_FACILITY_CORE SLANG_FACILITY_BASE

/* Facility for codes, that are not uniquely defined/protected. Can be used to pass back a specific error without requiring system wide facility uniqueness. Codes

should never be part of a public API. */

#define SLANG_FACILITY_INTERNAL SLANG_FACILITY_BASE + 1

/// Base for external facilities. Facilities should be unique across modules.

#define SLANG_FACILITY_EXTERNAL_BASE 0x210

/* ************************ Win COM compatible Results ******************************/

// https://msdn.microsoft.com/en-us/library/windows/desktop/aa378137(v=vs.85).aspx

//! SLANG_OK indicates success, and is equivalent to SLANG_MAKE_SUCCESS(SLANG_FACILITY_WIN_GENERAL, 0)

#define SLANG_OK 0

//! SLANG_FAIL is the generic failure code - meaning a serious error occurred and the call couldn't complete

#define SLANG_FAIL SLANG_MAKE_ERROR(SLANG_FACILITY_WIN_GENERAL, 0x4005)

#define SLANG_MAKE_WIN_GENERAL_ERROR(code) SLANG_MAKE_ERROR(SLANG_FACILITY_WIN_GENERAL, code)

//! Functionality is not implemented

#define SLANG_E_NOT_IMPLEMENTED SLANG_MAKE_WIN_GENERAL_ERROR(0x4001)

//! Interface not be found

#define SLANG_E_NO_INTERFACE SLANG_MAKE_WIN_GENERAL_ERROR(0x4002)

//! Operation was aborted (did not correctly complete)

#define SLANG_E_ABORT SLANG_MAKE_WIN_GENERAL_ERROR(0x4004)

//! Indicates that a handle passed in as parameter to a method is invalid.

#define SLANG_E_INVALID_HANDLE SLANG_MAKE_ERROR(SLANG_FACILITY_WIN_API, 6)

//! Indicates that an argument passed in as parameter to a method is invalid.

#define SLANG_E_INVALID_ARG SLANG_MAKE_ERROR(SLANG_FACILITY_WIN_API, 0x57)

//! Operation could not complete - ran out of memory

#define SLANG_E_OUT_OF_MEMORY SLANG_MAKE_ERROR(SLANG_FACILITY_WIN_API, 0xe)

/* *************************** other Results **************************************/

#define SLANG_MAKE_CORE_ERROR(code) SLANG_MAKE_ERROR(SLANG_FACILITY_CORE, code)

// Supplied buffer is too small to be able to complete

#define SLANG_E_BUFFER_TOO_SMALL SLANG_MAKE_CORE_ERROR(1)

//! Used to identify a Result that has yet to be initialized.

//! It defaults to failure such that if used incorrectly will fail, as similar in concept to using an uninitialized variable.

#define SLANG_E_UNINITIALIZED SLANG_MAKE_CORE_ERROR(2)

//! Returned from an async method meaning the output is invalid (thus an error), but a result for the request is pending, and will be returned on a subsequent call with the async handle.

#define SLANG_E_PENDING SLANG_MAKE_CORE_ERROR(3)

//! Indicates a file/resource could not be opened

#define SLANG_E_CANNOT_OPEN SLANG_MAKE_CORE_ERROR(4)

//! Indicates a file/resource could not be found

#define SLANG_E_NOT_FOUND SLANG_MAKE_CORE_ERROR(5)

//! An unhandled internal failure (typically from unhandled exception)

#define SLANG_E_INTERNAL_FAIL SLANG_MAKE_CORE_ERROR(6)

//! Could not complete because some underlying feature (hardware or software) was not available

#define SLANG_E_NOT_AVAILABLE SLANG_MAKE_CORE_ERROR(7)

/** A "Universally Unique Identifier" (UUID)

The Slang API uses UUIDs to identify interfaces when

using `queryInterface`.

This type is compatible with the `GUID` type defined

by the Component Object Model (COM), but Slang is

not dependent on COM.

*/

struct SlangUUID

};

// Place at the start of an interface with the guid.

// Guid should be specified as SLANG_COM_INTERFACE(0x00000000, 0x0000, 0x0000, { 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46 })

// NOTE: it's the typical guid struct definition, without the surrounding {}

// It is not necessary to use the multiple parameters (we can wrap in parens), but this is simple.

#define SLANG_COM_INTERFACE(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \

public: \

SLANG_FORCE_INLINE static const SlangUUID& getTypeGuid() \

{ \

static const SlangUUID guid = { a, b, c, d0, d1, d2, d3, d4, d5, d6, d7 }; \

return guid; \

}

// Sometimes it's useful to associate a guid with a class to identify it. This macro can used for this,

// and the guid extracted via the getTypeGuid() function defined in the type

#define SLANG_CLASS_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \

SLANG_FORCE_INLINE static const SlangUUID& getTypeGuid() \

{ \

static const SlangUUID guid = { a, b, c, d0, d1, d2, d3, d4, d5, d6, d7 }; \

return guid; \

}

/** Base interface for components exchanged through the API.

This interface definition is compatible with the COM `IUnknown`,

and uses the same UUID, but Slang does not require applications

to use or initialize COM.

*/

struct ISlangUnknown

{

SLANG_COM_INTERFACE(0x00000000, 0x0000, 0x0000, { 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46 })

virtual SLANG_NO_THROW SlangResult SLANG_MCALL queryInterface(SlangUUID const& uuid, void** outObject) = 0;

virtual SLANG_NO_THROW uint32_t SLANG_MCALL addRef() = 0;

virtual SLANG_NO_THROW uint32_t SLANG_MCALL release() = 0;

/*

Inline methods are provided to allow the above operations to be called

using their traditional COM names/signatures:

*/

SlangResult QueryInterface(struct _GUID const& uuid, void** outObject) { return queryInterface(*(SlangUUID const*)&uuid, outObject); }

uint32_t AddRef() { return addRef(); }

uint32_t Release() { return release(); }

};

#define SLANG_UUID_ISlangUnknown ISlangUnknown::getTypeGuid()

/** A "blob" of binary data.

This interface definition is compatible with the `ID3DBlob` and `ID3D10Blob` interfaces.

*/

struct ISlangBlob : public ISlangUnknown

};

#define SLANG_UUID_ISlangBlob ISlangBlob::getTypeGuid()

/** A (real or virtual) file system.

Slang can make use of this interface whenever it would otherwise try to load files

from disk, allowing applications to hook and/or override filesystem access from

the compiler.

It is the responsibility of

the caller of any method that returns a ISlangBlob to release the blob when it is no

longer used (using 'release').

*/

struct ISlangFileSystem : public ISlangUnknown

};

#define SLANG_UUID_ISlangFileSystem ISlangFileSystem::getTypeGuid()

typedef void(*SlangFuncPtr)(void);

/** An interface that can be used to encapsulate access to a shared library. An implementation

does not have to implement the library as a shared library.

*/

struct ISlangSharedLibrary: public ISlangUnknown

};

#define SLANG_UUID_ISlangSharedLibrary ISlangSharedLibrary::getTypeGuid()

struct ISlangSharedLibraryLoader: public ISlangUnknown

};

#define SLANG_UUID_ISlangSharedLibraryLoader ISlangSharedLibraryLoader::getTypeGuid()

/* Type that identifies how a path should be interpreted */

typedef unsigned int SlangPathType;

enum

{

SLANG_PATH_TYPE_DIRECTORY, /**< Path specified specifies a directory. */

SLANG_PATH_TYPE_FILE, /**< Path specified is to a file. */

};

/* Callback to enumerate the contents of of a directory in a ISlangFileSystemExt.

The name is the name of a file system object (directory/file) in the specified path (ie it is without a path) */

typedef void (*FileSystemContentsCallBack)(SlangPathType pathType, const char* name, void* userData);

/** An extended file system abstraction.