1 /* do not edit automatically generated by mc from StrLib. */
2 /* StrLib.def provides string manipulation procedures.
4 Copyright (C) 2001-2024 Free Software Foundation, Inc.
5 Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>.
7 This file is part of GNU Modula-2.
9 GNU Modula-2 is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3, or (at your option)
14 GNU Modula-2 is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 Under Section 7 of GPL version 3, you are granted additional
20 permissions described in the GCC Runtime Library Exception, version
21 3.1, as published by the Free Software Foundation.
23 You should have received a copy of the GNU General Public License and
24 a copy of the GCC Runtime Library Exception along with this program;
25 see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
26 <http://www.gnu.org/licenses/>. */
29 #if !defined (_StrLib_H)
38 # if !defined (PROC_D)
40 typedef void (*PROC_t
) (void);
41 typedef struct { PROC_t proc
; } PROC
;
45 # if defined (_StrLib_C)
48 # define EXTERN extern
53 StrConCat - combines a and b into c.
56 EXTERN
void StrLib_StrConCat (const char *a_
, unsigned int _a_high
, const char *b_
, unsigned int _b_high
, char *c
, unsigned int _c_high
);
59 StrLess - returns TRUE if string, a, alphabetically occurs before
63 EXTERN
bool StrLib_StrLess (const char *a_
, unsigned int _a_high
, const char *b_
, unsigned int _b_high
);
66 StrEqual - performs a = b on two strings.
69 EXTERN
bool StrLib_StrEqual (const char *a_
, unsigned int _a_high
, const char *b_
, unsigned int _b_high
);
72 StrLen - returns the length of string, a.
75 EXTERN
unsigned int StrLib_StrLen (const char *a_
, unsigned int _a_high
);
78 StrCopy - copy string src into string dest providing dest is large enough.
79 If dest is smaller than a then src then the string is truncated when
80 dest is full. Add a nul character if there is room in dest.
83 EXTERN
void StrLib_StrCopy (const char *src_
, unsigned int _src_high
, char *dest
, unsigned int _dest_high
);
86 IsSubString - returns true if b is a subcomponent of a.
89 EXTERN
bool StrLib_IsSubString (const char *a_
, unsigned int _a_high
, const char *b_
, unsigned int _b_high
);
92 StrRemoveWhitePrefix - copies string, into string, b, excluding any white
96 EXTERN
void StrLib_StrRemoveWhitePrefix (const char *a_
, unsigned int _a_high
, char *b
, unsigned int _b_high
);