amath  1.8.5
Simple command line calculator
amathc.h
Go to the documentation of this file.
1 /*-
2  * Copyright (c) 2014-2018 Carsten Sonne Larsen <cs@innolan.net>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  * Project homepage:
26  * https://amath.innolan.net
27  *
28  */
29 
30 #ifndef AMATHC_H
31 #define AMATHC_H
32 
33 /**
34  * @file amathc.h
35  * @brief C functions for manipulating strings and memory
36  */
37 
38 #include <stddef.h>
39 #include "amath.h"
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 typedef struct
46 {
47  const char* tag;
48  const char* text;
49 } texttag;
50 
51 void* AllocMemSafe(size_t);
52 void FreeMemSafe(void*);
53 void DetachMemSafe(void*);
54 void FreeAllSafe();
55 void MemUsage(long*, long*, long*);
56 int StrLen(const char* string);
57 bool StrIsEqual(const char* s1, const char* s2);
58 void MemSet(void* destination, int c0, unsigned int length);
59 void MemCopy(void* destination, const void* source, unsigned int length);
60 unsigned int AllocAndCopy(char** destination, const char* source);
61 void Untag(char* destination, const char* source,
62  texttag tags[], unsigned int tagcount);
63 
64 #ifdef __cplusplus
65 }
66 #endif
67 
68 #endif
texttag::text
const char * text
Definition: amathc.h:48
MemUsage
void MemUsage(long *blocks, long *size, long *peak)
Get memory usage in the global memory list.
Definition: mem.c:242
StrIsEqual
bool StrIsEqual(const char *s1, const char *s2)
Compare two null terminated strings to each other.
Definition: strcmp.c:50
AllocMemSafe
void * AllocMemSafe(size_t size)
Allocate memory and add it to the global memory list.
Definition: mem.c:86
FreeMemSafe
void FreeMemSafe(void *block)
Deallocate memory from the global memory list.
Definition: mem.c:200
Untag
void Untag(char *destination, const char *source, texttag tags[], unsigned int tagcount)
Definition: untag.c:32
StrLen
int StrLen(const char *string)
Get the length of a null terminated string.
Definition: strlen.c:34
FreeAllSafe
void FreeAllSafe()
Deallocate all memory in the global memory list.
Definition: mem.c:217
texttag::tag
const char * tag
Definition: amathc.h:47
MemSet
void MemSet(void *dst0, int c0, unsigned int length)
Fill block of memory with a constant value.
Definition: memset.c:56
AllocAndCopy
unsigned int AllocAndCopy(char **destination, const char *source)
Allocate memory and copy a string into the array.
Definition: alloccpy.c:40
MemCopy
void MemCopy(void *destination, const void *source, unsigned int length)
Copy a block of memory, handling overlap.
Definition: memcpy.c:75
DetachMemSafe
void DetachMemSafe(void *block)
Detach an allocated memory from the global memory list.
Definition: mem.c:209