1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2013 David Chisnall 5 * All rights reserved. 6 * 7 * This software was developed by SRI International and the University of 8 * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237) 9 * ("CTSRD"), as part of the DARPA CRASH research programme. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * $FreeBSD$ 33 */ 34 35 #ifndef _UTIL_HH_ 36 #define _UTIL_HH_ 37 38 #include <memory> 39 #include <stdint.h> 40 #include <string> 41 #include <vector> 42 43 // If we aren't using C++11, then just ignore static asserts. 44 #if __cplusplus < 201103L 45 #ifndef static_assert 46 #define static_assert(x, y) ((void)0) 47 #endif 48 #endif 49 50 namespace dtc { 51 52 /** 53 * Type for a buffer of bytes. This is used for a lot of short-lived temporary 54 * variables, so may eventually be changed to something like LLVM's 55 * SmallVector, but currently the program runs in a tiny fraction of a second, 56 * so this is not an issue. 57 */ 58 typedef std::vector<uint8_t> byte_buffer; 59 60 /** 61 * Helper function to push a big endian value into a byte buffer. We use 62 * native-endian values for all of the in-memory data structures and only 63 * transform them into big endian form for output. 64 */ 65 template<typename T> 66 inline void push_big_endian(byte_buffer &v, T val) 67 { 68 static_assert(sizeof(T) > 1, 69 "Big endian doesn't make sense for single-byte values"); 70 for (int bit=(sizeof(T) - 1)*8 ; bit>=0 ; bit-= 8) 71 { 72 v.push_back((val >> bit) & 0xff); 73 } 74 } 75 76 void push_string(byte_buffer &v, const std::string &s, bool escapes=false); 77 78 /** 79 * Simple inline non-locale-aware check that this is a valid ASCII 80 * digit. 81 */ 82 inline bool isdigit(char c) 83 { 84 return (c >= '0') && (c <= '9'); 85 } 86 87 /** 88 * Simple inline non-locale-aware check that this is a valid ASCII 89 * hex digit. 90 */ 91 inline bool ishexdigit(char c) 92 { 93 return ((c >= '0') && (c <= '9')) || ((c >= 'a') && (c <= 'f')) || 94 ((c >= 'A') && (c <= 'F')); 95 } 96 97 /** 98 * Simple inline non-locale-aware check that this is a valid ASCII 99 * letter. 100 */ 101 inline bool isalpha(char c) 102 { 103 return ((c >= 'a') && (c <= 'z')) || ((c >= 'A') && (c <= 'Z')); 104 } 105 106 /** 107 * A wrapper around dirname(3) that handles inconsistencies relating to memory 108 * management between platforms and provides a std::string interface. 109 */ 110 std::string dirname(const std::string&); 111 112 /** 113 * A wrapper around basename(3) that handles inconsistencies relating to memory 114 * management between platforms and provides a std::string interface. 115 */ 116 std::string basename(const std::string&); 117 118 }// namespace dtc 119 120 #endif // !_UTIL_HH_ 121