From dfe81014f7a7c0026e309ff3885ed6ab6fb44882 Mon Sep 17 00:00:00 2001 From: Mark Mentovai Date: Thu, 31 Jul 2014 13:45:51 -0400 Subject: [PATCH] Add compat to Crashpad. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit compat includes headers providing definitions normally provided by the system, in cases where the system SDK does not always provide the correct or up-to-date definitions, and cases where code on different platforms needs to access definitions normally only available on one platform. To provide definitions on a single platform, where the system SDK may not provide the definitions correctly, use subdirectories named for the platform, such as “mac”. To provide definitions normally available on only one platform to others, use subdirectories that identify that they are to be used on platforms other than the one that originated their definitions, such as “non_win”. In all cases, headers should be named as they are natively in their respective SDKs, so that it’s possible to #include them according to their usual names. R=rsesek@chromium.org Review URL: https://codereview.chromium.org/432843002 --- compat/compat.gyp | 43 + compat/mac/AvailabilityMacros.h | 50 + compat/mac/mach-o/loader.h | 32 + compat/mac/mach/mach.h | 90 ++ compat/mac/servers/bootstrap.h | 28 + compat/non_win/dbghelp.h | 850 ++++++++++++ compat/non_win/minwinbase.h | 49 + compat/non_win/timezoneapi.h | 61 + compat/non_win/verrsrc.h | 184 +++ compat/non_win/winnt.h | 182 +++ crashpad.doxy | 2311 +++++++++++++++++++++++++++++++ crashpad.doxy.h | 21 + crashpad.gyp | 2 + 13 files changed, 3903 insertions(+) create mode 100644 compat/compat.gyp create mode 100644 compat/mac/AvailabilityMacros.h create mode 100644 compat/mac/mach-o/loader.h create mode 100644 compat/mac/mach/mach.h create mode 100644 compat/mac/servers/bootstrap.h create mode 100644 compat/non_win/dbghelp.h create mode 100644 compat/non_win/minwinbase.h create mode 100644 compat/non_win/timezoneapi.h create mode 100644 compat/non_win/verrsrc.h create mode 100644 compat/non_win/winnt.h create mode 100644 crashpad.doxy create mode 100644 crashpad.doxy.h diff --git a/compat/compat.gyp b/compat/compat.gyp new file mode 100644 index 00000000..d88e5511 --- /dev/null +++ b/compat/compat.gyp @@ -0,0 +1,43 @@ +# Copyright 2014 The Crashpad Authors. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +{ + 'targets': [ + { + 'target_name': 'compat', + 'type': 'none', + 'include_dirs': [ + 'mac', + 'non_win', + ], + 'direct_dependent_settings': { + 'include_dirs': [ + 'mac', + 'non_win', + ], + }, + 'sources': [ + 'mac/AvailabilityMacros.h', + 'mac/mach/mach.h', + 'mac/mach-o/loader.h', + 'mac/servers/bootstrap.h', + 'non_win/dbghelp.h', + 'non_win/minwinbase.h', + 'non_win/timezoneapi.h', + 'non_win/verrsrc.h', + 'non_win/winnt.h', + ], + }, + ], +} diff --git a/compat/mac/AvailabilityMacros.h b/compat/mac/AvailabilityMacros.h new file mode 100644 index 00000000..69de4f69 --- /dev/null +++ b/compat/mac/AvailabilityMacros.h @@ -0,0 +1,50 @@ +// Copyright 2014 The Crashpad Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#ifndef CRASHPAD_COMPAT_MAC_AVAILABILITYMACROS_H_ +#define CRASHPAD_COMPAT_MAC_AVAILABILITYMACROS_H_ + +#include_next + +// 10.6 SDK + +#ifndef MAC_OS_X_VERSION_10_6 +#define MAC_OS_X_VERSION_10_6 1060 +#endif + +// 10.7 SDK + +#ifndef MAC_OS_X_VERSION_10_7 +#define MAC_OS_X_VERSION_10_7 1070 +#endif + +// 10.8 SDK + +#ifndef MAC_OS_X_VERSION_10_8 +#define MAC_OS_X_VERSION_10_8 1080 +#endif + +// 10.9 SDK + +#ifndef MAC_OS_X_VERSION_10_9 +#define MAC_OS_X_VERSION_10_9 1090 +#endif + +// 10.10 SDK + +#ifndef MAC_OS_X_VERSION_10_10 +#define MAC_OS_X_VERSION_10_10 101000 +#endif + +#endif // CRASHPAD_COMPAT_MAC_AVAILABILITYMACROS_H_ diff --git a/compat/mac/mach-o/loader.h b/compat/mac/mach-o/loader.h new file mode 100644 index 00000000..95a73574 --- /dev/null +++ b/compat/mac/mach-o/loader.h @@ -0,0 +1,32 @@ +// Copyright 2014 The Crashpad Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#ifndef CRASHPAD_COMPAT_MAC_MACH_O_LOADER_H_ +#define CRASHPAD_COMPAT_MAC_MACH_O_LOADER_H_ + +#include_next + +// 10.7 SDK + +#ifndef S_THREAD_LOCAL_ZEROFILL +#define S_THREAD_LOCAL_ZEROFILL 0x12 +#endif + +// 10.8 SDK + +#ifndef LC_SOURCE_VERSION +#define LC_SOURCE_VERSION 0x2a +#endif + +#endif // CRASHPAD_COMPAT_MAC_MACH_O_LOADER_H_ diff --git a/compat/mac/mach/mach.h b/compat/mac/mach/mach.h new file mode 100644 index 00000000..22b9ad8b --- /dev/null +++ b/compat/mac/mach/mach.h @@ -0,0 +1,90 @@ +// Copyright 2014 The Crashpad Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#ifndef CRASHPAD_COMPAT_MAC_MACH_MACH_H_ +#define CRASHPAD_COMPAT_MAC_MACH_MACH_H_ + +#include_next + +// + +// 10.8 SDK + +#ifndef EXC_RESOURCE +#define EXC_RESOURCE 11 +#endif + +#ifndef EXC_MASK_RESOURCE +#define EXC_MASK_RESOURCE (1 << EXC_RESOURCE) +#endif + +// 10.9 SDK + +#ifndef EXC_GUARD +#define EXC_GUARD 12 +#endif + +#ifndef EXC_MASK_GUARD +#define EXC_MASK_GUARD (1 << EXC_GUARD) +#endif + +// Don’t expose EXC_MASK_ALL or EXC_MASK_VALID at all, because their definitions +// vary with SDK, and older kernels will reject values that they don’t +// understand. Instead, use crashpad::ExcMaskAll(), which computes the correct +// value of EXC_MASK_ALL for the running system. +#undef EXC_MASK_ALL +#undef EXC_MASK_VALID + +#if defined(__i386__) || defined(__x86_64__) + +// + +// 10.9 SDK + +#if EXC_TYPES_COUNT > 13 // Definition varies with SDK +#error Update this file for new exception types +#elif EXC_TYPES_COUNT != 13 +#undef EXC_TYPES_COUNT +#define EXC_TYPES_COUNT 13 +#endif + +// + +// 10.6 SDK + +#ifndef x86_AVX_STATE32 +#define x86_AVX_STATE32 16 +#endif + +#ifndef x86_AVX_STATE64 +#define x86_AVX_STATE64 17 +#endif + +// 10.8 SDK + +#ifndef x86_AVX_STATE +#define x86_AVX_STATE 18 +#endif + +#endif // defined(__i386__) || defined(__x86_64__) + +// + +// 10.8 SDK + +#ifndef THREAD_STATE_FLAVOR_LIST_10_9 +#define THREAD_STATE_FLAVOR_LIST_10_9 129 +#endif + +#endif // CRASHPAD_COMPAT_MAC_MACH_MACH_H_ diff --git a/compat/mac/servers/bootstrap.h b/compat/mac/servers/bootstrap.h new file mode 100644 index 00000000..fc3c11c5 --- /dev/null +++ b/compat/mac/servers/bootstrap.h @@ -0,0 +1,28 @@ +// Copyright 2014 The Crashpad Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#ifndef CRASHPAD_COMPAT_MAC_SERVERS_BOOTSTRAP_H_ +#define CRASHPAD_COMPAT_MAC_SERVERS_BOOTSTRAP_H_ + +#include_next + +// + +// 10.6 SDK + +#ifndef BOOTSTRAP_NO_CHILDREN +#define BOOTSTRAP_NO_CHILDREN 1106 +#endif + +#endif // CRASHPAD_COMPAT_MAC_SERVERS_BOOTSTRAP_H_ diff --git a/compat/non_win/dbghelp.h b/compat/non_win/dbghelp.h new file mode 100644 index 00000000..85cf4ccb --- /dev/null +++ b/compat/non_win/dbghelp.h @@ -0,0 +1,850 @@ +// Copyright 2014 The Crashpad Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#ifndef CRASHPAD_COMPAT_NON_WIN_DBGHELP_H_ +#define CRASHPAD_COMPAT_NON_WIN_DBGHELP_H_ + +#include + +#include "base/strings/string16.h" +#include "compat/non_win/timezoneapi.h" +#include "compat/non_win/verrsrc.h" +#include "compat/non_win/winnt.h" + +//! \file + +//! \brief The magic number for a minidump file, stored in +//! MINIDUMP_HEADER::Signature. +//! +//! A hex dump of a little-endian minidump file will begin with the string +//! “MDMP”. +#define MINIDUMP_SIGNATURE ('PMDM') // 0x4d444d50 + +//! \brief The version of a minidump file, stored in MINIDUMP_HEADER::Version. +#define MINIDUMP_VERSION (42899) + +//! \brief An offset within a minidump file, relative to the start of its +//! MINIDUMP_HEADER. +//! +//! RVA stands for “relative virtual address”. Within a minidump file, RVAs are +//! used as pointers to link structures together. +//! +//! \sa MINIDUMP_LOCATION_DESCRIPTOR +typedef uint32_t RVA; + +//! \brief A pointer to a structure or union within a minidump file. +struct __attribute__((packed, aligned(4))) MINIDUMP_LOCATION_DESCRIPTOR { + //! \brief The size of the referenced structure or union, in bytes. + uint32_t DataSize; + + //! \brief The relative virtual address of the structure or union within the + //! minidump file. + RVA Rva; +}; + +//! \brief A pointer to a snapshot of a region of memory contained within a +//! minidump file. +//! +//! \sa MINIDUMP_MEMORY_LIST +struct __attribute__((packed, aligned(4))) MINIDUMP_MEMORY_DESCRIPTOR { + //! \brief The base address of the memory region in the address space of the + //! process that the minidump file contains a snapshot of. + uint64_t StartOfMemoryRange; + + //! \brief The contents of the memory region. + MINIDUMP_LOCATION_DESCRIPTOR Memory; +}; + +//! \brief The top-level structure identifying a minidump file. +//! +//! This structure contains a pointer to the stream directory, a second-level +//! structure which in turn contains pointers to third-level structures +//! (“streams”) containing the data within the minidump file. This structure +//! also contains the minidump file’s magic numbers, and other bookkeeping data. +//! +//! This structure must be present at the beginning of a minidump file (at ::RVA +//! 0). +struct __attribute__((packed, aligned(4))) MINIDUMP_HEADER { + //! \brief The minidump file format magic number, ::MINIDUMP_SIGNATURE. + uint32_t Signature; + + //! \brief The minidump file format version number, ::MINIDUMP_VERSION. + uint32_t Version; + + //! \brief The number of MINIDUMP_DIRECTORY elements present in the directory + //! referenced by #StreamDirectoryRva. + uint32_t NumberOfStreams; + + //! \brief A pointer to an array of MINIDUMP_DIRECTORY structures that + //! identify all of the streams within this minidump file. The array has + //! #NumberOfStreams elements present. + RVA StreamDirectoryRva; + + //! \brief The minidump file’s checksum. This can be `0`, and in practice, `0` + //! is the only value that has ever been seen in this field. + uint32_t CheckSum; + + //! \brief The time that the minidump file was generated, in `time_t` format, + //! the number of seconds since the POSIX epoch. + uint32_t TimeDateStamp; + + //! \brief A bitfield containing members of ::MINIDUMP_TYPE, describing the + //! types of data carried within this minidump file. + uint64_t Flags; +}; + +//! \brief A pointer to a stream within a minidump file. +//! +//! Each stream present in a minidump file will have a corresponding +//! MINIDUMP_DIRECTORY entry in the stream directory referenced by +//! MINIDUMP_HEADER::StreamDirectoryRva. +struct __attribute__((packed, aligned(4))) MINIDUMP_DIRECTORY { + //! \brief The type of stream referenced, a value of ::MINIDUMP_STREAM_TYPE. + uint32_t StreamType; + + //! \brief A pointer to the stream data within the minidump file. + MINIDUMP_LOCATION_DESCRIPTOR Location; +}; + +//! \brief A variable-length UTF-16-encoded string carried within a minidump +//! file. +//! +//! The UTF-16 string is stored as UTF-16LE or UTF-16BE according to the byte +//! ordering of the minidump file itself. +//! +//! \sa crashpad::MinidumpUTF8String +struct __attribute__((packed, aligned(4))) MINIDUMP_STRING { + //! \brief The length of the #Buffer field in bytes, not including the `NUL` + //! terminator. + //! + //! \note This field is interpreted as a byte count, not a count of UTF-16 + //! code units or Unicode code points. + uint32_t Length; + + //! \brief The string, encoded in UTF-16, and terminated with a UTF-16 `NUL` + //! code unit (two `NUL` bytes). + char16 Buffer[0]; +}; + +//! \brief Minidump stream type values for MINIDUMP_DIRECTORY::StreamType. Each +//! stream structure has a corresponding stream type value to identify it. +//! +//! \sa crashpad::MinidumpStreamType +enum MINIDUMP_STREAM_TYPE { + //! \brief The stream type for MINIDUMP_THREAD_LIST. + ThreadListStream = 3, + + //! \brief The stream type for MINIDUMP_MODULE_LIST. + ModuleListStream = 4, + + //! \brief The stream type for MINIDUMP_MEMORY_LIST. + MemoryListStream = 5, + + //! \brief The stream type for MINIDUMP_EXCEPTION_STREAM. + ExceptionStream = 6, + + //! \brief The stream type for MINIDUMP_SYSTEM_INFO. + SystemInfoStream = 7, + + //! \brief The stream type for MINIDUMP_MISC_INFO, MINIDUMP_MISC_INFO_2, + //! MINIDUMP_MISC_INFO_3, and MINIDUMP_MISC_INFO_4. + //! + //! More recent versions of this stream are supersets of earlier versions. + //! + //! The exact version of the stream that is present is implied by the stream’s + //! size. Furthermore, this stream contains a field, + //! MINIDUMP_MISC_INFO_STREAM::Flags1, that indicates which data is present + //! and valid. + MiscInfoStream = 15, +}; + +//! \brief Information about the CPU (or CPUs) that ran the process that the +//! minidump file contains a snapshot of. +//! +//! This union only appears as MINIDUMP_SYSTEM_INFO::Cpu. Its interpretation is +//! controlled by MINIDUMP_SYSTEM_INFO::ProcessorArchitecture. +union __attribute__((packed, aligned(4))) CPU_INFORMATION { + //! \brief Information about 32-bit x86 CPUs, or x86_64 CPUs when running + //! 32-bit x86 processes. + struct __attribute__((packed, aligned(4))) { + //! \brief The CPU’s vendor identification string as encoded in `cpuid 0` + //! `ebx`, `edx`, and `ecx`, represented as it appears in these + //! registers. + //! + //! For Intel CPUs, `[0]` will encode “Genu”, `[1]` will encode “ineI”, and + //! `[2]` will encode “ntel”, for a vendor ID string “GenuineIntel”. + //! + //! \note The Windows documentation incorrectly states that these fields are + //! to be interpreted as `cpuid 0` `eax`, `ebx`, and `ecx`. + uint32_t VendorId[3]; + + //! \brief Family, model, and stepping ID values as encoded in `cpuid 1` + //! `eax`. + uint32_t VersionInformation; + + //! \brief A bitfield containing supported CPU capabilities as encoded in + //! `cpuid 1` `edx`. + uint32_t FeatureInformation; + + //! \brief A bitfield containing supported CPU capabalities as encoded in + //! `cpuid 0x80000001` `edx`. + //! + //! This field is only valid if #VendorId identifies the CPU vendor as + //! “AuthenticAMD”. + uint32_t AMDExtendedCpuFeatures; + } X86CpuInfo; + + //! \brief Information about non-x86 CPUs, and x86_64 CPUs when not running + //! 32-bit x86 processes. + struct __attribute__((packed, aligned(4))) { + //! \brief Bitfields containing supported CPU capabilities as identified by + //! bits corresponding to `PF_*` values passed to + //! `IsProcessorFeaturePresent()`. + uint64_t ProcessorFeatures[2]; + } OtherCpuInfo; +}; + +//! \brief Information about the system that hosted the process that the +//! minidump file contains a snapshot of. +struct __attribute__((packed, aligned(4))) MINIDUMP_SYSTEM_INFO { + // The next 4 fields are from the SYSTEM_INFO structure returned by + // GetSystemInfo(). + + //! \brief The system’s CPU architecture. This may be a \ref + //! PROCESSOR_ARCHITECTURE_x "PROCESSOR_ARCHITECTURE_*" value, or a member + //! of crashpad::MinidumpCPUArchitecture. + //! + //! In some cases, a system may be able to run processes of multiple specific + //! architecture types. For example, systems based on 64-bit architectures + //! such as x86_64 are often able to run 32-bit code of another architecture + //! in the same family, such as 32-bit x86. On these systems, this field will + //! identify the architecture of the process that the minidump file contains a + //! snapshot of. + uint16_t ProcessorArchitecture; + + //! \brief General CPU version information. + //! + //! The precise interpretation of this field is specific to each CPU + //! architecture. For x86-family CPUs (including x86_64 and 32-bit x86), this + //! field contains the CPU family ID value from `cpuid 1` `eax`, adjusted to + //! take the extended family ID into account. + uint16_t ProcessorLevel; + + //! \brief Specific CPU version information. + //! + //! The precise interpretation of this field is specific to each CPU + //! architecture. For x86-family CPUs (including x86_64 and 32-bit x86), this + //! field contains values obtained from `cpuid 1` `eax`: the high byte + //! contains the CPU model ID value adjusted to take the extended model ID + //! into account, and the low byte contains the CPU stepping ID value. + uint16_t ProcessorRevision; + + //! \brief The total number of CPUs present in the system. + uint8_t NumberOfProcessors; + + // The next 7 fields are from the OSVERSIONINFOEX structure returned by + // GetVersionEx(). + + //! \brief The system’s operating system type, which distinguishes between + //! “desktop” or “workstation” systems and “server” systems. This may be a + //! \ref VER_NT_x "VER_NT_*" value, or a member of + //! crashpad::MinidumpOSType. + uint8_t ProductType; + + //! \brief The system’s operating system version number’s first (major) + //! component. + //! + //! - For Windows 7 (NT 6.1) SP1, version 6.1.7601, this would be `6`. + //! - For Mac OS X 10.9.2, this would be `10`. + uint32_t MajorVersion; + + //! \brief The system’s operating system version number’s second (minor) + //! component. + //! + //! - For Windows 7 (NT 6.1) SP1, version 6.1.7601, this would be `1`. + //! - For Mac OS X 10.9.2, this would be `9`. + uint32_t MinorVersion; + + //! \brief The system’s operating system version number’s third (build or + //! patch) component. + //! + //! - For Windows 7 (NT 6.1) SP1, version 6.1.7601, this would be `7601`. + //! - For Mac OS X 10.9.2, this would be `2`. + uint32_t BuildNumber; + + //! \brief The system’s operating system family. This may be a \ref + //! VER_PLATFORM_x "VER_PLATFORM_*" value, or a member of + //! crashpad::MinidumpOS. + uint32_t PlatformId; + + //! \brief ::RVA of a MINIDUMP_STRING containing operating system-specific + //! version information. + //! + //! This field further identifies an operating system version beyond its + //! version number fields. Historically, “CSD” stands for “corrective service + //! diskette.” + //! + //! - On Windows, this is the name of the installed operating system service + //! pack, such as “Service Pack 1”. If no service pack is installed, this + //! field references an empty string. + //! - On Mac OS X, this is the operating system build number from `sw_vers + //! -buildVersion`. For Mac OS X 10.9.2 on most hardware types, this would + //! be `13C64`. + //! - On Linux and other Unix-like systems, this is the kernel version from + //! `uname -srvm`, possibly with additional information appended. On + //! Android, the `ro.build.fingerprint` system property is appended. + RVA CSDVersionRva; + + //! \brief A bitfield identifying products installed on the system. This is + //! composed of \ref VER_SUITE_x "VER_SUITE_*" values. + //! + //! This field is Windows-specific, and has no meaning on other operating + //! systems. + uint16_t SuiteMask; + + uint16_t Reserved2; + + //! \brief Information about the system’s CPUs. + //! + //! This field is a union. Which of its members should be expressed is + //! controlled by the #ProcessorArchitecture field. If it is set to + //! crashpad::kMinidumpCPUArchitectureX86, the CPU_INFORMATION::X86CpuInfo + //! field is expressed. Otherwise, the CPU_INFORMATION::OtherCpuInfo field is + //! expressed. + //! + //! \note Older Breakpad implementations produce minidump files that express + //! CPU_INFORMATION::X86CpuInfo when #ProcessorArchitecture is set to + //! crashpad::kMinidumpCPUArchitectureAMD64. Minidump files produced by + //! `dbghelp.dll` on Windows express CPU_INFORMATION::OtherCpuInfo in this + //! case. + CPU_INFORMATION Cpu; +}; + +//! \brief Information about a specific thread within the process. +//! +//! \sa MINIDUMP_THREAD_LIST +struct __attribute__((packed, aligned(4))) MINIDUMP_THREAD { + //! \brief The thread’s ID. This may be referenced by + //! MINIDUMP_EXCEPTION_STREAM::ThreadId. + uint32_t ThreadId; + + //! \brief The thread’s suspend count. + //! + //! This field will be `0` if the thread is schedulable (not suspended). + uint32_t SuspendCount; + + //! \brief The thread’s priority class. + //! + //! On Windows, this is a `*_PRIORITY_CLASS` value. `NORMAL_PRIORITY_CLASS` + //! has value `0x20`; higher priority classes have higher values. + uint32_t PriorityClass; + + //! \brief The thread’s priority level. + //! + //! On Windows, this is a `THREAD_PRIORITY_*` value. `THREAD_PRIORITY_NORMAL` + //! has value `0`; higher priorities have higher values, and lower priorities + //! have lower (negative) values. + uint32_t Priority; + + //! \brief The address of the thread’s thread environment block in the address + //! space of the process that the minidump file contains a snapshot of. + //! + //! The thread environment block contains thread-local data. + //! + //! A MINIDUMP_MEMORY_DESCRIPTOR may be present in the MINIDUMP_MEMORY_LIST + //! stream containing the thread-local data pointed to by this field. + uint64_t Teb; + + //! \brief A snapshot of the thread’s stack. + //! + //! A MINIDUMP_MEMORY_DESCRIPTOR may be present in the MINIDUMP_MEMORY_LIST + //! stream containing a pointer to the same memory range referenced by this + //! field. + MINIDUMP_MEMORY_DESCRIPTOR Stack; + + //! \brief A pointer to a CPU-specific CONTEXT structure containing the + //! thread’s context at the time the snapshot was taken. + //! + //! If the minidump file was generated as a result of an exception taken on + //! this thread, this field may identify a different context than the + //! exception context. For these minidump files, a MINIDUMP_EXCEPTION_STREAM + //! stream will be present, and the context contained within that stream will + //! be the exception context. + //! + //! The interpretation of the context structure is dependent on the CPU + //! architecture identified by MINIDUMP_SYSTEM_INFO::ProcessorArchitecture. + //! For crashpad::kMinidumpCPUArchitectureX86, this will be + //! crashpad::MinidumpContextX86. For crashpad::kMinidumpCPUArchitectureAMD64, + //! this will be crashpad::MinidumpContextAMD64. + MINIDUMP_LOCATION_DESCRIPTOR ThreadContext; +}; + +//! \brief Information about all threads within the process. +struct __attribute__((packed, aligned(4))) MINIDUMP_THREAD_LIST { + //! \brief The number of threads present in the #Threads array. + uint32_t NumberOfThreads; + + //! \brief Structures identifying each thread within the process. + MINIDUMP_THREAD Threads[0]; +}; + +//! \brief Information about an exception that occurred in the process. +struct __attribute__((packed, aligned(4))) MINIDUMP_EXCEPTION { + //! \brief The top-level exception code identifying the exception, in + //! operating system-specific values. + //! + //! For Mac OS X minidumps, this will be a value of + //! crashpad::MinidumpExceptionCodeMac, which corresponds to an `EXC_*` + //! exception type. `EXC_CRASH` will not appear here for exceptions processed + //! as `EXC_CRASH` when generated from another preceding exception: the + //! original exception code will appear instead. The exception type as it was + //! received will appear at index 0 of #ExceptionInformation. + //! + //! \note This field is named ExceptionCode, but what is known as the + //! “exception code” on Mac OS X/Mach is actually stored in the + //! #ExceptionFlags field of a minidump file. + //! + //! \todo Document the possible values by OS. There should be OS-specific + //! enums in minidump_extensions.h. + uint32_t ExceptionCode; + + //! \brief Additional exception flags that further identify the exception, in + //! operating system-specific values. + //! + //! For Mac OS X minidumps, this will be the value of the exception code at + //! index 0 as received by a Mach exception handler. For exception type + //! `EXC_CRASH` generated from another preceding exception, the original + //! exception code will appear here, not the code as received by the Mach + //! exception handler. The code as it was received will appear at index 1 of + //! #ExceptionInformation. + //! + //! \todo Document the possible values by OS. There should be OS-specific + //! enums in minidump_extensions.h. + uint32_t ExceptionFlags; + + //! \brief An address, in the address space of the process that this minidump + //! file contains a snapshot of, of another MINIDUMP_EXCEPTION. This field + //! is used for nested exceptions. + uint64_t ExceptionRecord; + + //! \brief The address that caused the exception. + //! + //! This may be the address that caused a fault on data access, or it may be + //! the instruction pointer that contained an offending instruction. + uint64_t ExceptionAddress; + + //! \brief The number of valid elements in #ExceptionInformation. + uint32_t NumberParameters; + + uint32_t __unusedAlignment; + + //! \brief Additional information about the exception, specific to the + //! operating system and possibly the #ExceptionCode. + //! + //! For Mac OS X minidumps, this will contain the exception type as received + //! by a Mach exception handler and the values of the `codes[0]` and + //! `codes[1]` (exception code and subcode) parameters supplied to the Mach + //! exception handler. Unlike #ExceptionCode and #ExceptionFlags, the values + //! received by a Mach exception handler are used directly here even for the + //! `EXC_CRASH` exception type. + uint64_t ExceptionInformation[EXCEPTION_MAXIMUM_PARAMETERS]; +}; + +//! \brief Information about the exception that triggered a minidump file’s +//! generation. +struct __attribute__((packed, aligned(4))) MINIDUMP_EXCEPTION_STREAM { + //! \brief The ID of the thread that caused the exception. + //! + //! \sa MINIDUMP_THREAD::ThreadId + uint32_t ThreadId; + + uint32_t __alignment; + + //! \brief Information about the exception. + MINIDUMP_EXCEPTION ExceptionRecord; + + //! \brief A pointer to a CPU-specific CONTEXT structure containing the + //! thread’s context at the time the exception was caused. + //! + //! The interpretation of the context structure is dependent on the CPU + //! architecture identified by MINIDUMP_SYSTEM_INFO::ProcessorArchitecture. + //! For crashpad::kMinidumpCPUArchitectureX86, this will be + //! crashpad::MinidumpContextX86. For crashpad::kMinidumpCPUArchitectureAMD64, + //! this will be crashpad::MinidumpContextAMD64. + MINIDUMP_LOCATION_DESCRIPTOR ThreadContext; +}; + +//! \brief Information about a specific module loaded within the process at the +//! time the snapshot was taken. +//! +//! A module may be the main executable, a shared library, or a loadable module. +//! +//! \sa MINIDUMP_MODULE_LIST +struct __attribute__((packed, aligned(4))) MINIDUMP_MODULE { + //! \brief The base address of the loaded module in the address space of the + //! process that the minidump file contains a snapshot of. + uint64_t BaseOfImage; + + //! \brief The size of the loaded module. + uint32_t SizeOfImage; + + //! \brief The loaded module’s checksum, or `0` if unknown. + //! + //! On Windows, this field comes from the `CheckSum` field of the module’s + //! `IMAGE_OPTIONAL_HEADER` structure, if present. It reflects the checksum at + //! the time the module was linked. + uint32_t CheckSum; + + //! \brief The module’s timestamp, in `time_t` units, seconds since the POSIX + //! epoch. + //! + //! On Windows, this field comes from the `TimeDateStamp` field of the + //! module’s `IMAGE_HEADER` structure. It reflects the timestamp at the time + //! the module was linked. + uint32_t TimeDateStamp; + + //! \brief ::RVA of a MINIDUMP_STRING containing the module’s path or file + //! name. + RVA ModuleNameRva; + + //! \brief The module’s version information. + VS_FIXEDFILEINFO VersionInfo; + + //! \brief A pointer to the module’s CodeView record, typically a link to its + //! debugging information in crashpad::MinidumpModuleCodeViewRecordPDB70 + //! format. + //! + //! The specific format of the CodeView record is indicated by its signature, + //! the first 32-bit value in the structure. For links to debugging + //! information in contemporary usage, this is normally a + //! crashpad::MinidumpModuleCodeViewRecordPDB70 structure, but may be a + //! crashpad::MinidumpModuleCodeViewRecordPDB20 structure instead. These + //! structures identify a link to debugging data within a `.pdb` (Program + //! Database) file. See Matching + //! Debug Information, PDB Files. + //! + //! On Windows, it is also possible for the CodeView record to contain + //! debugging information itself, as opposed to a link to a `.pdb` file. See + //! Microsoft + //! Symbol and Type Information, section 7.2, “Debug Information Format” + //! for a list of debug information formats, and Undocumented + //! Windows 2000 Secrets, Windows 2000 Debugging Support/Microsoft Symbol + //! File Internals/CodeView Subsections for an in-depth description of the + //! CodeView 4.1 format. Signatures seen in the wild include “NB09” + //! (0x3930424e) for CodeView 4.1 and “NB11” (0x3131424e) for CodeView 5.0. + //! This form of debugging information within the module, as opposed to a link + //! to an external `.pdb` file, is chosen by building with `/Z7`. + //! + //! On Windows, the CodeView record is taken from a module’s + //! IMAGE_DEBUG_DIRECTORY entry whose Type field has the value + //! IMAGE_DEBUG_TYPE_CODEVIEW (`2`), if any. Records in + //! crashpad::MinidumpModuleCodeViewRecordPDB70 format are generated by Visual + //! Studio .NET (2002) (version 7.0) and later. + //! + //! When the CodeView record is not present, the fields of this + //! MINIDUMP_LOCATION_DESCRIPTOR will be `0`. + MINIDUMP_LOCATION_DESCRIPTOR CvRecord; + + //! \brief A pointer to the module’s miscellaneous debugging record, a + //! structure of type IMAGE_DEBUG_MISC. + //! + //! This field is Windows-specific, and has no meaning on other operating + //! systems. It is largely obsolete on Windows, where it was used to link to + //! debugging information stored in a `.dbg` file. `.dbg` files have been + //! superseded by `.pdb` files. + //! + //! On Windows, the miscellaneous debugging record is taken from module’s + //! IMAGE_DEBUG_DIRECTORY entry whose Type field has the value + //! IMAGE_DEBUG_TYPE_MISC (`4`), if any. + //! + //! When the miscellaneous debugging record is not present, the fields of this + //! MINIDUMP_LOCATION_DESCRIPTOR will be `0`. + //! + //! \sa #CvRecord + MINIDUMP_LOCATION_DESCRIPTOR MiscRecord; + + uint64_t Reserved0; + uint64_t Reserved1; +}; + +//! \brief Information about all modules loaded within the process at the time +//! the snapshot was taken. +struct __attribute__((packed, aligned(4))) MINIDUMP_MODULE_LIST { + //! \brief The number of modules present in the #Modules array. + uint32_t NumberOfModules; + + //! \brief Structures identifying each module present in the minidump file. + MINIDUMP_MODULE Modules[0]; +}; + +//! \brief Information about memory regions within the process. +//! +//! Typically, a minidump file will not contain a snapshot of a process’ entire +//! memory image. For minidump files identified as ::MiniDumpNormal in +//! MINIDUMP_HEADER::Flags, memory regions are limited to those referenced by +//! MINIDUMP_THREAD::Stack fields, and a small number of others possibly related +//! to the exception that triggered the snapshot to be taken. +struct __attribute__((packed, aligned(4))) MINIDUMP_MEMORY_LIST { + //! \brief The number of memory regions present in the #MemoryRanges array. + uint32_t NumberOfMemoryRanges; + + //! \brief Structures identifying each memory region present in the minidump + //! file. + MINIDUMP_MEMORY_DESCRIPTOR MemoryRanges[0]; +}; + +//! \anchor MINIDUMP_MISCx +//! \name MINIDUMP_MISC* +//! +//! \brief Field validity flag values for MINIDUMP_MISC_INFO::Flags1. +//! \{ + +//! \brief MINIDUMP_MISC_INFO::ProcessId is valid. +#define MINIDUMP_MISC1_PROCESS_ID 0x00000001 + +//! \brief The time-related fields in MINIDUMP_MISC_INFO are valid. +//! +//! The following fields are valid: +//! - MINIDUMP_MISC_INFO::ProcessCreateTime +//! - MINIDUMP_MISC_INFO::ProcessUserTime +//! - MINIDUMP_MISC_INFO::ProcessKernelTime +#define MINIDUMP_MISC1_PROCESS_TIMES 0x00000002 + +//! \brief The CPU-related fields in MINIDUMP_MISC_INFO_2 are valid. +//! +//! The following fields are valid: +//! - MINIDUMP_MISC_INFO_2::ProcessorMaxMhz +//! - MINIDUMP_MISC_INFO_2::ProcessorCurrentMhz +//! - MINIDUMP_MISC_INFO_2::ProcessorMhzLimit +//! - MINIDUMP_MISC_INFO_2::ProcessorMaxIdleState +//! - MINIDUMP_MISC_INFO_2::ProcessorCurrentIdleState +//! +//! \note This macro should likely have been named +//! MINIDUMP_MISC2_PROCESSOR_POWER_INFO. +#define MINIDUMP_MISC1_PROCESSOR_POWER_INFO 0x00000004 + +//! \brief MINIDUMP_MISC_INFO3::ProcessIntegrityLevel is valid. +#define MINIDUMP_MISC3_PROCESS_INTEGRITY 0x00000010 + +//! \brief MINIDUMP_MISC_INFO3::ProcessExecuteFlags is valid. +#define MINIDUMP_MISC3_PROCESS_EXECUTE_FLAGS 0x00000020 + +//! \brief The time zone-related fields in MINIDUMP_MISC_INFO_3 are valid. +//! +//! The following fields are valid: +//! - MINIDUMP_MISC_INFO_3::TimeZoneId +//! - MINIDUMP_MISC_INFO_3::TimeZone +#define MINIDUMP_MISC3_TIMEZONE 0x00000040 + +//! \brief MINIDUMP_MISC_INFO3::ProtectedProcess is valid. +#define MINIDUMP_MISC3_PROTECTED_PROCESS 0x00000080 + +//! \brief The build string-related fields in MINIDUMP_MISC_INFO_4 are valid. +//! +//! The following fields are valid: +//! - MINIDUMP_MISC_INFO_4::BuildString +//! - MINIDUMP_MISC_INFO_4::DbgBldStr +#define MINIDUMP_MISC4_BUILDSTRING 0x00000100 +//! \} + +//! \brief Information about the process that the minidump file contains a +//! snapshot of, as well as the system that hosted that process. +//! +//! \sa \ref MINIDUMP_MISCx "MINIDUMP_MISC*" +//! \sa MINIDUMP_MISC_INFO_2 +//! \sa MINIDUMP_MISC_INFO_3 +//! \sa MINIDUMP_MISC_INFO_4 +//! \sa MINIDUMP_MISC_INFO_N +struct __attribute__((packed, aligned(4))) MINIDUMP_MISC_INFO { + //! \brief The size of the structure. + //! + //! This field can be used to distinguish between different versions of this + //! structure: MINIDUMP_MISC_INFO, MINIDUMP_MISC_INFO_2, MINIDUMP_MISC_INFO_3, + //! and MINIDUMP_MISC_INFO_4. + //! + //! \sa Flags1 + uint32_t SizeOfInfo; + + //! \brief A bit field of \ref MINIDUMP_MISCx "MINIDUMP_MISC*" values + //! indicating which fields of this structure contain valid data. + uint32_t Flags1; + + //! \brief The process ID of the process. + uint32_t ProcessId; + + //! \brief The time that the process started, in `time_t` units, seconds since + //! the POSIX epoch. + uint32_t ProcessCreateTime; + + //! \brief The amount of user-mode CPU time used by the process, in seconds, + //! at the time of the snapshot. + uint32_t ProcessUserTime; + + //! \brief The amount of system-mode (kernel) CPU time used by the process, in + //! seconds, at the time of the snapshot. + uint32_t ProcessKernelTime; +}; + +//! \brief Information about the process that the minidump file contains a +//! snapshot of, as well as the system that hosted that process. +//! +//! This structure variant is used on Windows Vista (NT 6.0) and later. +//! +//! \sa \ref MINIDUMP_MISCx "MINIDUMP_MISC*" +//! \sa MINIDUMP_MISC_INFO +//! \sa MINIDUMP_MISC_INFO_3 +//! \sa MINIDUMP_MISC_INFO_4 +//! \sa MINIDUMP_MISC_INFO_N +struct __attribute__((packed, aligned(4))) MINIDUMP_MISC_INFO_2 + : public MINIDUMP_MISC_INFO { + //! \brief The maximum clock rate of the system’s CPU or CPUs, in MHz. + uint32_t ProcessorMaxMhz; + + //! \brief The clock rate of the system’s CPU or CPUs, in MHz, at the time of + //! the snapshot. + uint32_t ProcessorCurrentMhz; + + //! \brief The maximum clock rate of the system’s CPU or CPUs, in MHz, reduced + //! by any thermal limitations, at the time of the snapshot. + uint32_t ProcessorMhzLimit; + + //! \brief The maximum idle state of the system’s CPU or CPUs. + uint32_t ProcessorMaxIdleState; + + //! \brief The idle state of the system’s CPU or CPUs at the time of the + //! snapshot. + uint32_t ProcessorCurrentIdleState; +}; + +//! \brief Information about the process that the minidump file contains a +//! snapshot of, as well as the system that hosted that process. +//! +//! This structure variant is used on Windows 7 (NT 6.1) and later. +//! +//! \sa \ref MINIDUMP_MISCx "MINIDUMP_MISC*" +//! \sa MINIDUMP_MISC_INFO +//! \sa MINIDUMP_MISC_INFO_2 +//! \sa MINIDUMP_MISC_INFO_4 +//! \sa MINIDUMP_MISC_INFO_N +struct __attribute__((packed, aligned(4))) MINIDUMP_MISC_INFO_3 + : public MINIDUMP_MISC_INFO_2 { + //! \brief The process’ integrity level. + //! + //! Windows typically uses `SECURITY_MANDATORY_MEDIUM_RID` (0x2000) for + //! processes belonging to normal authenticated users and + //! `SECURITY_MANDATORY_HIGH_RID` (0x3000) for elevated processes. + //! + //! This field is Windows-specific, and has no meaning on other operating + //! systems. + uint32_t ProcessIntegrityLevel; + + //! \brief The process’ execute flags. + //! + //! On Windows, this appears to be returned by `NtQueryInformationProcess()` + //! with an argument of `ProcessExecuteFlags` (34). + //! + //! This field is Windows-specific, and has no meaning on other operating + //! systems. + uint32_t ProcessExecuteFlags; + + //! \brief Whether the process is protected. + //! + //! This field is Windows-specific, and has no meaning on other operating + //! systems. + uint32_t ProtectedProcess; + + //! \brief Whether daylight saving time was being observed in the system’s + //! location at the time of the snapshot. + //! + //! This field can contain the following values: + //! - `0` if the location does not observe daylight saving time at all. The + //! TIME_ZONE_INFORMATION::StandardName field of #TimeZoneId contains the + //! time zone name. + //! - `1` if the location observes daylight saving time, but standard time + //! was in effect at the time of the snapshot. The + //! TIME_ZONE_INFORMATION::StandardName field of #TimeZoneId contains the + //! time zone name. + //! - `2` if the location observes daylight saving time, and it was in effect + //! at the time of the snapshot. The TIME_ZONE_INFORMATION::DaylightName + //! field of #TimeZoneId contains the time zone name. + //! + //! \sa #TimeZone + uint32_t TimeZoneId; + + //! \brief Information about the time zone at the system’s location. + //! + //! \sa #TimeZoneId + TIME_ZONE_INFORMATION TimeZone; +}; + +//! \brief Information about the process that the minidump file contains a +//! snapshot of, as well as the system that hosted that process. +//! +//! This structure variant is used on Windows 8 (NT 6.2) and later. +//! +//! \sa \ref MINIDUMP_MISCx "MINIDUMP_MISC*" +//! \sa MINIDUMP_MISC_INFO +//! \sa MINIDUMP_MISC_INFO_2 +//! \sa MINIDUMP_MISC_INFO_3 +//! \sa MINIDUMP_MISC_INFO_N +struct __attribute__((packed, aligned(4))) MINIDUMP_MISC_INFO_4 + : public MINIDUMP_MISC_INFO_3 { + //! \brief The operating system’s “build string”, a string identifying a + //! specific build of the operating system. + //! + //! This string is UTF-16-encoded and terminated by a UTF-16 `NUL` code unit. + //! + //! On Windows 8.1 (NT 6.3), this is “6.3.9600.17031 + //! (winblue_gdr.140221-1952)”. + char16 BuildString[260]; + + //! \brief The minidump producer’s “build string”, a string identifying the + //! module that produced a minidump file. + //! + //! This string is UTF-16-encoded and terminated by a UTF-16 `NUL` code unit. + //! + //! On Windows 8.1 (NT 6.3), this may be “dbghelp.i386,6.3.9600.16520” or + //! “dbghelp.amd64,6.3.9600.16520” depending on CPU architecture. + char16 DbgBldStr[40]; +}; + +//! \brief The latest known version of the MINIDUMP_MISC_INFO structure. +typedef MINIDUMP_MISC_INFO_4 MINIDUMP_MISC_INFO_N; + +//! \brief Minidump file type values for MINIDUMP_HEADER::Flags. These bits +//! describe the types of data carried within a minidump file. +enum MINIDUMP_TYPE { + //! \brief A minidump file without any additional data. + //! + //! This type of minidump file contains: + //! - A MINIDUMP_SYSTEM_INFO stream. + //! - A MINIDUMP_MISC_INFO, MINIDUMP_MISC_INFO_2, MINIDUMP_MISC_INFO_3, or + //! MINIDUMP_MISC_INFO_4 stream, depending on which fields are present. + //! - A MINIDUMP_THREAD_LIST stream. All threads are present, along with a + //! snapshot of each thread’s stack memory sufficient to obtain backtraces. + //! - If the minidump file was generated as a result of an exception, a + //! MINIDUMP_EXCEPTION_STREAM describing the exception. + //! - A MINIDUMP_MODULE_LIST stream. All loaded modules are present. + //! - Typically, a MINIDUMP_MEMORY_LIST stream containing duplicate pointers + //! to the stack memory regions also referenced by the MINIDUMP_THREAD_LIST + //! stream. Since Windows 7 (NT 6.1), this type of minidump file also + //! includes a MINIDUMP_MEMORY_DESCRIPTOR containing the 256 bytes centered + //! around the exception address or the instruction pointer. + MiniDumpNormal = 0x00000000, +}; + +#endif // CRASHPAD_COMPAT_NON_WIN_DBGHELP_H_ diff --git a/compat/non_win/minwinbase.h b/compat/non_win/minwinbase.h new file mode 100644 index 00000000..2761b1cc --- /dev/null +++ b/compat/non_win/minwinbase.h @@ -0,0 +1,49 @@ +// Copyright 2014 The Crashpad Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#ifndef CRASHPAD_COMPAT_NON_WIN_MINWINBASE_H_ +#define CRASHPAD_COMPAT_NON_WIN_MINWINBASE_H_ + +#include + +//! \brief Represents a date and time. +struct SYSTEMTIME { + //! \brief The year, represented fully. + //! + //! The year 2014 would be represented in this field as `2014`. + uint16_t wYear; + + //! \brief The month of the year, `1` for January and `12` for December. + uint16_t wMonth; + + //! \brief The day of the week, `0` for Sunday and `6` for Saturday. + uint16_t wDayOfWeek; + + //! \brief The day of the month, `1` through `31`. + uint16_t wDay; + + //! \brief The hour of the day, `0` through `23`. + uint16_t wHour; + + //! \brief The minute of the hour, `0` through `59`. + uint16_t wMinute; + + //! \brief The second of the minute, `0` through `60`. + uint16_t wSecond; + + //! \brief The millisecond of the second, `0` through `999`. + uint16_t wMilliseconds; +}; + +#endif // CRASHPAD_COMPAT_NON_WIN_MINWINBASE_H_ diff --git a/compat/non_win/timezoneapi.h b/compat/non_win/timezoneapi.h new file mode 100644 index 00000000..e78e3da1 --- /dev/null +++ b/compat/non_win/timezoneapi.h @@ -0,0 +1,61 @@ +// Copyright 2014 The Crashpad Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#ifndef CRASHPAD_COMPAT_NON_WIN_TIMEZONEAPI_H_ +#define CRASHPAD_COMPAT_NON_WIN_TIMEZONEAPI_H_ + +#include + +#include "base/strings/string16.h" +#include "compat/non_win/minwinbase.h" + +//! \brief Information about a time zone and its daylight saving rules. +struct TIME_ZONE_INFORMATION { + //! \brief The number of minutes west of UTC. + int32_t Bias; + + //! \brief The UTF-16-encoded name of the time zone when observing standard + //! time. + char16 StandardName[32]; + + //! \brief The date and time to switch from daylight saving time to standard + //! time. + //! + //! This can be a specific time, or with SYSTEMTIME::wYear set to `0`, it can + //! reflect an annual recurring transition. In that case, SYSTEMTIME::wDay in + //! the range `1` to `5` is interpreted as the given occurrence of + //! SYSTEMTIME::wDayOfWeek within the month, `1` being the first occurrence + //! and `5` being the last (even if there are fewer than 5). + SYSTEMTIME StandardDate; + + //! \brief The bias relative to #Bias to be applied when observing standard + //! time. + int32_t StandardBias; + + //! \brief The UTF-16-encoded name of the time zone when observing daylight + //! saving time. + char16 DaylightName[32]; + + //! \brief The date and time to switch from standard time to daylight saving + //! time. + //! + //! This field is specified in the same manner as #StandardDate. + SYSTEMTIME DaylightDate; + + //! \brief The bias relative to #Bias to be applied when observing daylight + //! saving time. + int32_t DaylightBias; +}; + +#endif // CRASHPAD_COMPAT_NON_WIN_TIMEZONEAPI_H_ diff --git a/compat/non_win/verrsrc.h b/compat/non_win/verrsrc.h new file mode 100644 index 00000000..70f53442 --- /dev/null +++ b/compat/non_win/verrsrc.h @@ -0,0 +1,184 @@ +// Copyright 2014 The Crashpad Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#ifndef CRASHPAD_COMPAT_NON_WIN_VERRSRC_H_ +#define CRASHPAD_COMPAT_NON_WIN_VERRSRC_H_ + +#include + +//! \file + +//! \brief The magic number for a VS_FIXEDFILEINFO structure, stored in +//! VS_FIXEDFILEINFO::dwSignature. +#define VS_FFI_SIGNATURE 0xfeef04bd + +//! \brief The version of a VS_FIXEDFILEINFO structure, stored in +//! VS_FIXEDFILEINFO::dwStrucVersion. +#define VS_FFI_STRUCVERSION 0x00010000 + +//! \anchor VS_FF_x +//! \name VS_FF_* +//! +//! \brief File attribute values for VS_FIXEDFILEINFO::dwFileFlags and +//! VS_FIXEDFILEINFO::dwFileFlagsMask. +//! \{ +#define VS_FF_DEBUG 0x00000001 +#define VS_FF_PRERELEASE 0x00000002 +#define VS_FF_PATCHED 0x00000004 +#define VS_FF_PRIVATEBUILD 0x00000008 +#define VS_FF_INFOINFERRED 0x00000010 +#define VS_FF_SPECIALBUILD 0x00000020 +//! \} + +//! \anchor VOS_x +//! \name VOS_* +//! +//! \brief Operating system values for VS_FIXEDFILEINFO::dwFileOS. +//! \{ +#define VOS_UNKNOWN 0x00000000 +#define VOS_DOS 0x00010000 +#define VOS_OS216 0x00020000 +#define VOS_OS232 0x00030000 +#define VOS_NT 0x00040000 +#define VOS_WINCE 0x00050000 +#define VOS__BASE 0x00000000 +#define VOS__WINDOWS16 0x00000001 +#define VOS__PM16 0x00000002 +#define VOS__PM32 0x00000003 +#define VOS__WINDOWS32 0x00000004 +#define VOS_DOS_WINDOWS16 0x00010001 +#define VOS_DOS_WINDOWS32 0x00010004 +#define VOS_OS216_PM16 0x00020002 +#define VOS_OS232_PM32 0x00030003 +#define VOS_NT_WINDOWS32 0x00040004 +//! \} + +//! \anchor VFT_x +//! \name VFT_* +//! +//! \brief File type values for VS_FIXEDFILEINFO::dwFileType. +//! \{ +#define VFT_UNKNOWN 0x00000000 +#define VFT_APP 0x00000001 +#define VFT_DLL 0x00000002 +#define VFT_DRV 0x00000003 +#define VFT_FONT 0x00000004 +#define VFT_VXD 0x00000005 +#define VFT_STATIC_LIB 0x00000007 +//! \} + +//! \anchor VFT2_x +//! \name VFT2_* +//! +//! \brief File subtype values for VS_FIXEDFILEINFO::dwFileSubtype. +//! \{ +#define VFT2_UNKNOWN 0x00000000 +#define VFT2_DRV_PRINTER 0x00000001 +#define VFT2_DRV_KEYBOARD 0x00000002 +#define VFT2_DRV_LANGUAGE 0x00000003 +#define VFT2_DRV_DISPLAY 0x00000004 +#define VFT2_DRV_MOUSE 0x00000005 +#define VFT2_DRV_NETWORK 0x00000006 +#define VFT2_DRV_SYSTEM 0x00000007 +#define VFT2_DRV_INSTALLABLE 0x00000008 +#define VFT2_DRV_SOUND 0x00000009 +#define VFT2_DRV_COMM 0x0000000A +#define VFT2_DRV_INPUTMETHOD 0x0000000B +#define VFT2_DRV_VERSIONED_PRINTER 0x0000000C +#define VFT2_FONT_RASTER 0x00000001 +#define VFT2_FONT_VECTOR 0x00000002 +#define VFT2_FONT_TRUETYPE 0x00000003 +//! \} + +//! \brief Version information for a file. +//! +//! On Windows, this information is derived from a file’s version information +//! resource, and is obtained by calling `VerQueryValue()` with an `lpSubBlock` +//! argument of `"\"` (a single backslash). +struct VS_FIXEDFILEINFO { + //! \brief The structure’s magic number, ::VS_FFI_SIGNATURE. + uint32_t dwSignature; + + //! \brief The structure’s version, ::VS_FFI_STRUCVERSION. + uint32_t dwStrucVersion; + + //! \brief The more-significant portion of the file’s version number. + //! + //! This field contains the first two components of a four-component version + //! number. For a file whose version is 1.2.3.4, this field would be + //! `0x00010002`. + //! + //! \sa dwFileVersionLS + uint32_t dwFileVersionMS; + + //! \brief The less-significant portion of the file’s version number. + //! + //! This field contains the last two components of a four-component version + //! number. For a file whose version is 1.2.3.4, this field would be + //! `0x00030004`. + //! + //! \sa dwFileVersionMS + uint32_t dwFileVersionLS; + + //! \brief The more-significant portion of the product’s version number. + //! + //! This field contains the first two components of a four-component version + //! number. For a product whose version is 1.2.3.4, this field would be + //! `0x00010002`. + //! + //! \sa dwProductVersionLS + uint32_t dwProductVersionMS; + + //! \brief The less-significant portion of the product’s version number. + //! + //! This field contains the last two components of a four-component version + //! number. For a product whose version is 1.2.3.4, this field would be + //! `0x00030004`. + //! + //! \sa dwProductVersionMS + uint32_t dwProductVersionLS; + + //! \brief A bitmask of \ref VS_FF_x "VS_FF_*" values indicating which bits in + //! #dwFileFlags are valid. + uint32_t dwFileFlagsMask; + + //! \brief A bitmask of \ref VS_FF_x "VS_FF_*" values identifying attributes + //! of the file. Only bits present in #dwFileFlagsMask are valid. + uint32_t dwFileFlags; + + //! \brief The file’s intended operating system, a value of \ref VOS_x + //! "VOS_*". + uint32_t dwFileOS; + + //! \brief The file’s type, a value of \ref VFT_x "VFT_*". + uint32_t dwFileType; + + //! \brief The file’s subtype, a value of \ref VFT2_x "VFT2_*" corresponding + //! to its #dwFileType, if the file type has subtypes. + uint32_t dwFileSubtype; + + //! \brief The more-significant portion of the file’s creation date. + //! + //! The intended encoding of this field is unknown. This field is unused and + //! always has the value `0`. + uint32_t dwFileDateMS; + + //! \brief The less-significant portion of the file’s creation date. + //! + //! The intended encoding of this field is unknown. This field is unused and + //! always has the value `0`. + uint32_t dwFileDateLS; +}; + +#endif // CRASHPAD_COMPAT_NON_WIN_VERRSRC_H_ diff --git a/compat/non_win/winnt.h b/compat/non_win/winnt.h new file mode 100644 index 00000000..e9ccacaa --- /dev/null +++ b/compat/non_win/winnt.h @@ -0,0 +1,182 @@ +// Copyright 2014 The Crashpad Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#ifndef CRASHPAD_COMPAT_NON_WIN_WINNT_H_ +#define CRASHPAD_COMPAT_NON_WIN_WINNT_H_ + +//! \file + +//! \anchor VER_SUITE_x +//! \name VER_SUITE_* +//! +//! \brief Installable product values for MINIDUMP_SYSTEM_INFO::SuiteMask. +//! \{ +#define VER_SUITE_SMALLBUSINESS 0x0001 +#define VER_SUITE_ENTERPRISE 0x0002 +#define VER_SUITE_BACKOFFICE 0x0004 +#define VER_SUITE_COMMUNICATIONS 0x0008 +#define VER_SUITE_TERMINAL 0x0010 +#define VER_SUITE_SMALLBUSINESS_RESTRICTED 0x0020 +#define VER_SUITE_EMBEDDEDNT 0x0040 +#define VER_SUITE_DATACENTER 0x0080 +#define VER_SUITE_SINGLEUSERTS 0x0100 +#define VER_SUITE_PERSONAL 0x0200 +#define VER_SUITE_BLADE 0x0400 +#define VER_SUITE_EMBEDDED_RESTRICTED 0x0800 +#define VER_SUITE_SECURITY_APPLIANCE 0x1000 +#define VER_SUITE_STORAGE_SERVER 0x2000 +#define VER_SUITE_COMPUTE_SERVER 0x4000 +#define VER_SUITE_WH_SERVER 0x8000 +//! \} + +//! \brief The maximum number of exception parameters present in the +//! MINIDUMP_EXCEPTION::ExceptionInformation array. +#define EXCEPTION_MAXIMUM_PARAMETERS 15 + +//! \anchor PROCESSOR_ARCHITECTURE_x +//! \name PROCESSOR_ARCHITECTURE_* +//! +//! \brief CPU type values for MINIDUMP_SYSTEM_INFO::ProcessorArchitecture. +//! +//! \sa crashpad::MinidumpCPUArchitecture +//! \{ +#define PROCESSOR_ARCHITECTURE_INTEL 0 +#define PROCESSOR_ARCHITECTURE_MIPS 1 +#define PROCESSOR_ARCHITECTURE_ALPHA 2 +#define PROCESSOR_ARCHITECTURE_PPC 3 +#define PROCESSOR_ARCHITECTURE_SHX 4 +#define PROCESSOR_ARCHITECTURE_ARM 5 +#define PROCESSOR_ARCHITECTURE_IA64 6 +#define PROCESSOR_ARCHITECTURE_ALPHA64 7 +#define PROCESSOR_ARCHITECTURE_MSIL 8 +#define PROCESSOR_ARCHITECTURE_AMD64 9 +#define PROCESSOR_ARCHITECTURE_IA32_ON_WIN64 10 +#define PROCESSOR_ARCHITECTURE_NEUTRAL 11 +#define PROCESSOR_ARCHITECTURE_UNKNOWN 0xffff +//! \} + +//! \anchor PF_x +//! \name PF_* +//! +//! \brief CPU feature values for +//! CPU_INFORMATION::OtherCpuInfo::ProcessorFeatures. +//! +//! \{ +#define PF_FLOATING_POINT_PRECISION_ERRATA 0 +#define PF_FLOATING_POINT_EMULATED 1 +#define PF_COMPARE_EXCHANGE_DOUBLE 2 +#define PF_MMX_INSTRUCTIONS_AVAILABLE 3 +#define PF_PPC_MOVEMEM_64BIT_OK 4 +#define PF_ALPHA_BYTE_INSTRUCTIONS 5 +#define PF_XMMI_INSTRUCTIONS_AVAILABLE 6 +#define PF_3DNOW_INSTRUCTIONS_AVAILABLE 7 +#define PF_RDTSC_INSTRUCTION_AVAILABLE 8 +#define PF_PAE_ENABLED 9 +#define PF_XMMI64_INSTRUCTIONS_AVAILABLE 10 +#define PF_SSE_DAZ_MODE_AVAILABLE 11 +#define PF_NX_ENABLED 12 +#define PF_SSE3_INSTRUCTIONS_AVAILABLE 13 +#define PF_COMPARE_EXCHANGE128 14 +#define PF_COMPARE64_EXCHANGE128 15 +#define PF_CHANNELS_ENABLED 16 +#define PF_XSAVE_ENABLED 17 +#define PF_ARM_VFP_32_REGISTERS_AVAILABLE 18 +#define PF_ARM_NEON_INSTRUCTIONS_AVAILABLE 19 +#define PF_SECOND_LEVEL_ADDRESS_TRANSLATION 20 +#define PF_VIRT_FIRMWARE_ENABLED 21 +#define PF_RDWRFSGSBASE_AVAILABLE 22 +#define PF_FASTFAIL_AVAILABLE 23 +#define PF_ARM_DIVIDE_INSTRUCTION_AVAILABLE 24 +#define PF_ARM_64BIT_LOADSTORE_ATOMIC 25 +#define PF_ARM_EXTERNAL_CACHE_AVAILABLE 26 +#define PF_ARM_FMAC_INSTRUCTIONS_AVAILABLE 27 +#define PF_RDRAND_INSTRUCTION_AVAILABLE 28 +//! \} + +//! \anchor IMAGE_DEBUG_MISC_x +//! \name IMAGE_DEBUG_MISC_* +//! +//! Data type values for IMAGE_DEBUG_MISC::DataType. +//! \{ + +//! \brief A pointer to a `.dbg` file. +//! +//! IMAGE_DEBUG_MISC::Data will contain the path or file name of the `.dbg` file +//! associated with the module. +#define IMAGE_DEBUG_MISC_EXENAME 1 + +//! \} + +//! \brief Miscellaneous debugging record. +//! +//! This structure is referenced by MINIDUMP_MODULE::MiscRecord. It is obsolete, +//! superseded by the CodeView record. +struct IMAGE_DEBUG_MISC { + //! \brief The type of data carried in the #Data field. + //! + //! This is a value of \ref IMAGE_DEBUG_MISC_x "IMAGE_DEBUG_MISC_*". + uint32_t DataType; + + //! \brief The length of this structure in bytes, including the entire #Data + //! field and its `NUL` terminator. + //! + //! \note The Windows documentation states that this field is rounded up to + //! nearest nearest 4-byte multiple. + uint32_t Length; + + //! \brief The encoding of the #Data field. + //! + //! If this field is `0`, #Data contains narrow or multibyte character data. + //! If this field is `1`, #Data is UTF-16-encoded. + //! + //! On Windows, with this field set to `0`, #Data will be encoded in the code + //! page of the system that linked the module. On other operating systems, + //! UTF-8 may be used. + uint8_t Unicode; + + uint8_t Reserved[3]; + + //! \brief The data carried within this structure. + //! + //! For string data, this field will be `NUL`-terminated. If #Unicode is `1`, + //! this field is UTF-16-encoded, and will be terminated by a UTF-16 `NUL` + //! code unit (two `NUL` bytes). + uint8_t Data[1]; +}; + +//! \anchor VER_NT_x +//! \name VER_NT_* +//! +//! \brief Operating system type values for MINIDUMP_SYSTEM_INFO::ProductType. +//! +//! \sa crashpad::MinidumpOSType +//! \{ +#define VER_NT_WORKSTATION 1 +#define VER_NT_DOMAIN_CONTROLLER 2 +#define VER_NT_SERVER 3 +//! \} + +//! \anchor VER_PLATFORM_x +//! \name VER_PLATFORM_* +//! +//! \brief Operating system family values for MINIDUMP_SYSTEM_INFO::PlatformId. +//! +//! \sa crashpad::MinidumpOS +//! \{ +#define VER_PLATFORM_WIN32s 0 +#define VER_PLATFORM_WIN32_WINDOWS 1 +#define VER_PLATFORM_WIN32_NT 2 +//! \} + +#endif // CRASHPAD_COMPAT_NON_WIN_WINNT_H_ diff --git a/crashpad.doxy b/crashpad.doxy new file mode 100644 index 00000000..0114a346 --- /dev/null +++ b/crashpad.doxy @@ -0,0 +1,2311 @@ +# Doxyfile 1.8.7 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Crashpad" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +# PROJECT_BRIEF = "Crashpad" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = out + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = . compat/mac compat/non_win + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = YES + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = YES + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = out \ + third_party + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 0 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /