gcc/m2/gm2-libs/StrLib.def

   1 (* StrLib.def provides string manipulation procedures.
   2
   3 Copyright (C) 2001-2024 Free Software Foundation, Inc.
   4 Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>.
   5
   6 This file is part of GNU Modula-2.
   7
   8 GNU Modula-2 is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 3, or (at your option)
  11 any later version.
  12
  13 GNU Modula-2 is distributed in the hope that it will be useful, but
  14 WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 General Public License for more details.
  17
  18 Under Section 7 of GPL version 3, you are granted additional
  19 permissions described in the GCC Runtime Library Exception, version
  20 3.1, as published by the Free Software Foundation.
  21
  22 You should have received a copy of the GNU General Public License and
  23 a copy of the GCC Runtime Library Exception along with this program;
  24 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  25 <http://www.gnu.org/licenses/>.  *)
  26
  27 DEFINITION MODULE StrLib ;
  28
  29 EXPORT QUALIFIED StrConCat, StrLen, StrCopy, StrEqual, StrLess,
  30                  IsSubString, StrRemoveWhitePrefix ;
  31
  32
  33 (*
  34    StrConCat - combines a and b into c.
  35 *)
  36
  37 PROCEDURE StrConCat (a, b: ARRAY OF CHAR; VAR c: ARRAY OF CHAR) ;
  38
  39
  40 (*
  41    StrLess - returns TRUE if string, a, alphabetically occurs before
  42              string, b.
  43 *)
  44
  45 PROCEDURE StrLess (a, b: ARRAY OF CHAR) : BOOLEAN ;
  46
  47
  48 (*
  49    StrEqual - performs a = b on two strings.
  50 *)
  51
  52 PROCEDURE StrEqual (a, b: ARRAY OF CHAR) : BOOLEAN ;
  53
  54
  55 (*
  56    StrLen - returns the length of string, a.
  57 *)
  58
  59 PROCEDURE StrLen (a: ARRAY OF CHAR) : CARDINAL ;
  60
  61
  62 (*
  63    StrCopy - copy string src into string dest providing dest is large enough.
  64              If dest is smaller than a then src then the string is truncated when
  65              dest is full.  Add a nul character if there is room in dest.
  66 *)
  67
  68 PROCEDURE StrCopy (src: ARRAY OF CHAR ; VAR dest: ARRAY OF CHAR) ;
  69
  70
  71 (*
  72    IsSubString - returns true if b is a subcomponent of a.
  73 *)
  74
  75 PROCEDURE IsSubString (a, b: ARRAY OF CHAR) : BOOLEAN ;
  76
  77
  78 (*
  79    StrRemoveWhitePrefix - copies string, into string, b, excluding any white
  80                           space infront of a.
  81 *)
  82
  83 PROCEDURE StrRemoveWhitePrefix (a: ARRAY OF CHAR; VAR b: ARRAY OF CHAR) ;
  84
  85
  86 END StrLib.