aboutsummaryrefslogtreecommitdiff
path: root/src/util.h
blob: 4faec6f9fcc5a97bbc3804bbd95ef832bbee2fea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/*

    casm - Simple, portable assembler

    Copyright (C) 2003-2015  Ian Cowburn (ianc@noddybox.co.uk)

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

    -------------------------------------------------------------------------

    Common utilities

*/

#ifndef CASM_UTIL_H
#define CASM_UTIL_H

#include <stdlib.h>


/* ---------------------------------------- INTERFACES
*/


/* Duplicate a string.  Just use free() to free.
*/
char    *DupStr(const char *p);


/* Malloc wrapper.  Just use free() to free.
*/
void    *Malloc(size_t len);


/* Realloc wrapper.  Just use free() to free.
*/
void    *Realloc(void *p, size_t len);


/* Remove end-of-line characters.  Returns the passed pointer.
*/
char    *RemoveNL(char *p);


/* Remove white space from the start and end of a string.
   Characters from the front are removed by memmov()ing the string, so the
   returned point is always the same as the passed 'p'.
*/
char    *Trim(char *p);


/* Remove passed characters from the start and end of a string.
   Characters from the front are removed by memmov()ing the string, so the
   returned point is always the same as the passed 'p'.
*/
char    *TrimChars(char *p, const char *chars);


/* Compare a string, but case insensitive.  Returns TRUE for match, otherwise
   FALSE.
*/
int     CompareString(const char *a, const char *b);


/* Compare a character, but case insensitive.  Returns TRUE for match, otherwise
   FALSE.
*/
int     CompareChar(char a, char b);


/* Compare the start of a string 'a' starts with string 'b', but case
   insensitive.  Returns TRUE for match, otherwise FALSE.
*/
int     CompareStart(const char *a, const char *b);


/* Compare the end of a string 'a' ends with string 'b', but case insensitive.
   Returns TRUE for match, otherwise FALSE.
*/
int     CompareEnd(const char *a, const char *b);


/* Strncpy, with a safety nulling of the last character.  Returns the 1st
   parameter.
*/
char    *CopyStr(char *dest, const char *src, size_t size);


/* Returns TRUE if a string is either a NULL pointer or just full of white space
*/
int     IsNullOrEmpty(const char *p);


/* Null function that can be used as a handy place to hang a breakpoint.
*/
void    DebugBreakPoint(void);


#endif

/*
vim: ai sw=4 ts=8 expandtab
*/