libcdr_utils.h Source File documentation

libcdr_utils.h
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2/*
3 * This file is part of the libcdr project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 */
9
10#ifndef __LIBCDR_UTILS_H__
11#define __LIBCDR_UTILS_H__
12
13#ifdef HAVE_CONFIG_H
14#include "config.h"
15#endif
16
17#include <math.h>
18#include <memory>
19#include <vector>
20
21#include <boost/cstdint.hpp>
22
23#include <librevenge-stream/librevenge-stream.h>
24#include <librevenge/librevenge.h>
25
26#ifndef M_PI
27#define M_PI 3.14159265358979323846
28#endif
29
30#define CDR_EPSILON 1E-6
31#define CDR_ALMOST_ZERO(m) (fabs(m) <= CDR_EPSILON)
32#define CDR_ALMOST_EQUAL(m, n) CDR_ALMOST_ZERO(m-n)
33
34#if defined(HAVE_FUNC_ATTRIBUTE_FORMAT)
35# define CDR_ATTRIBUTE_PRINTF(fmt, arg) __attribute__((__format__(__printf__, fmt, arg)))
36#else
37# define CDR_ATTRIBUTE_PRINTF(fmt, arg)
38#endif
39
40#if defined(HAVE_CLANG_ATTRIBUTE_FALLTHROUGH)
41# define CDR_FALLTHROUGH [[clang::fallthrough]]
42#elif defined(HAVE_GCC_ATTRIBUTE_FALLTHROUGH)
43# define CDR_FALLTHROUGH __attribute__((fallthrough))
44#else
45# define CDR_FALLTHROUGH ((void) 0)
46#endif
47
48// do nothing with debug messages in a release compile
49#ifdef DEBUG
50namespace libcdr
51{
52void debugPrint(const char *format, ...) CDR_ATTRIBUTE_PRINTF(1, 2);
53}
54#define CDR_DEBUG_MSG(M) libcdr::debugPrint M
55#define CDR_DEBUG(M) M
56#else
57#define CDR_DEBUG_MSG(M)
58#define CDR_DEBUG(M)
59#endif
60
61namespace libcdr
62{
63
64 struct CDRDummyDeleter
65{
66 void operator()(void *) const {}
67};
68
69template<typename T, typename... Args>
70std::unique_ptr<T> make_unique(Args &&... args)
71{
72 return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
73}
74
75uint8_t readU8(librevenge::RVNGInputStream *input, bool bigEndian=false);
76uint16_t readU16(librevenge::RVNGInputStream *input, bool bigEndian=false);
77uint32_t readU32(librevenge::RVNGInputStream *input, bool bigEndian=false);
78uint64_t readU64(librevenge::RVNGInputStream *input, bool bigEndian=false);
79int32_t readS32(librevenge::RVNGInputStream *input, bool bigEndian=false);
80int16_t readS16(librevenge::RVNGInputStream *input, bool bigEndian=false);
81
82double readDouble(librevenge::RVNGInputStream *input, bool bigEndian=false);
83
84double readFixedPoint(librevenge::RVNGInputStream *input, bool bigEndian=false);
85
86unsigned long getLength(librevenge::RVNGInputStream *input);
87unsigned long getRemainingLength(librevenge::RVNGInputStream *input);
88
89int cdr_round(double d);
90
91void writeU16(librevenge::RVNGBinaryData &buffer, const int value);
92void writeU32(librevenge::RVNGBinaryData &buffer, const int value);
93void appendCharacters(librevenge::RVNGString &text, std::vector<unsigned char> characters, unsigned short charset);
94void appendCharacters(librevenge::RVNGString &text, std::vector<unsigned char> characters);
95void appendUTF8Characters(librevenge::RVNGString &text, std::vector<unsigned char> characters);
96
97#ifdef DEBUG
98const char *toFourCC(unsigned value, bool bigEndian=false);
99#endif
100
101 class EndOfStreamException
102{
103};
104
105 class GenericException
106{
107};
108
109 class UnknownPrecisionException
110{
111};
112
113 class EncodingException
114{
115};
116
117} // namespace libcdr
118
119#endif // __LIBCDR_UTILS_H__
120/* vim:set shiftwidth=2 softtabstop=2 expandtab: */
libcdr::EncodingException
Definition libcdr_utils.h:114
libcdr::EndOfStreamException
Definition libcdr_utils.h:102
libcdr::GenericException
Definition libcdr_utils.h:106
libcdr::UnknownPrecisionException
Definition libcdr_utils.h:110
CDR_ATTRIBUTE_PRINTF
#define CDR_ATTRIBUTE_PRINTF(fmt, arg)
Definition libcdr_utils.h:37
libcdr
Definition CDRCollector.h:25
libcdr::readDouble
double readDouble(librevenge::RVNGInputStream *input, bool bigEndian=false)
Definition libcdr_utils.cpp:249
libcdr::appendUTF8Characters
void appendUTF8Characters(librevenge::RVNGString &text, std::vector< unsigned char > characters)
Definition libcdr_utils.cpp:465
libcdr::readU8
uint8_t readU8(librevenge::RVNGInputStream *input, bool bigEndian=false)
Definition libcdr_utils.cpp:163
libcdr::readFixedPoint
double readFixedPoint(librevenge::RVNGInputStream *input, bool bigEndian=false)
Definition libcdr_utils.cpp:262
libcdr::writeU32
void writeU32(librevenge::RVNGBinaryData &buffer, const int value)
Definition libcdr_utils.cpp:317
libcdr::writeU16
void writeU16(librevenge::RVNGBinaryData &buffer, const int value)
Definition libcdr_utils.cpp:311
libcdr::readU64
uint64_t readU64(librevenge::RVNGInputStream *input, bool bigEndian=false)
Definition libcdr_utils.cpp:229
libcdr::appendCharacters
void appendCharacters(librevenge::RVNGString &text, std::vector< unsigned char > characters, unsigned short charset)
Definition libcdr_utils.cpp:325
libcdr::getLength
unsigned long getLength(librevenge::RVNGInputStream *input)
Definition libcdr_utils.cpp:270
libcdr::cdr_round
int cdr_round(double d)
Definition libcdr_utils.cpp:306
libcdr::readS32
int32_t readS32(librevenge::RVNGInputStream *input, bool bigEndian=false)
Definition libcdr_utils.cpp:224
libcdr::readU32
uint32_t readU32(librevenge::RVNGInputStream *input, bool bigEndian=false)
Definition libcdr_utils.cpp:204
libcdr::make_unique
std::unique_ptr< T > make_unique(Args &&... args)
Definition libcdr_utils.h:70
libcdr::readU16
uint16_t readU16(librevenge::RVNGInputStream *input, bool bigEndian=false)
Definition libcdr_utils.cpp:179
libcdr::readS16
int16_t readS16(librevenge::RVNGInputStream *input, bool bigEndian=false)
Definition libcdr_utils.cpp:199
libcdr::getRemainingLength
unsigned long getRemainingLength(librevenge::RVNGInputStream *input)
Definition libcdr_utils.cpp:301
libcdr::CDRDummyDeleter
Definition libcdr_utils.h:65
libcdr::CDRDummyDeleter::operator()
void operator()(void *) const
Definition libcdr_utils.h:66