xref: /petsc/src/sys/utils/str.c (revision 4996c5bd2b13cb007116b5c4779695bde909dcf1)
17d0a6c19SBarry Smith 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay     We define the string operations here. The reason we just do not use
4e5c89e4eSSatish Balay   the standard string routines in the PETSc code is that on some machines
5e5c89e4eSSatish Balay   they are broken or have the wrong prototypes.
6e5c89e4eSSatish Balay 
7e5c89e4eSSatish Balay */
8c6db04a5SJed Brown #include <petscsys.h>                   /*I  "petscsys.h"   I*/
9e5c89e4eSSatish Balay #if defined(PETSC_HAVE_STRING_H)
10e5c89e4eSSatish Balay #include <string.h>
11e5c89e4eSSatish Balay #endif
12e5c89e4eSSatish Balay #if defined(PETSC_HAVE_STRINGS_H)
13e5c89e4eSSatish Balay #include <strings.h>
14e5c89e4eSSatish Balay #endif
15e5c89e4eSSatish Balay 
16e5c89e4eSSatish Balay #undef __FUNCT__
173c311c98SBarry Smith #define __FUNCT__ "PetscStrToArray"
183c311c98SBarry Smith /*@C
19d67fe73bSBarry Smith    PetscStrToArray - Seperates a string by a charactor (for example ' ' or '\n') and creates an array of strings
203c311c98SBarry Smith 
213c311c98SBarry Smith    Not Collective
223c311c98SBarry Smith 
233c311c98SBarry Smith    Input Parameters:
24d67fe73bSBarry Smith +  s - pointer to string
25d67fe73bSBarry Smith -  sp - seperator charactor
263c311c98SBarry Smith 
273c311c98SBarry Smith    Output Parameter:
283c311c98SBarry Smith +   argc - the number of entries in the array
293c311c98SBarry Smith -   args - an array of the entries with a null at the end
303c311c98SBarry Smith 
313c311c98SBarry Smith    Level: intermediate
323c311c98SBarry Smith 
33301d30feSBarry Smith    Notes: this may be called before PetscInitialize() or after PetscFinalize()
343c311c98SBarry Smith 
356f013253SBarry Smith    Not for use in Fortran
366f013253SBarry Smith 
37b4cd4cebSBarry Smith    Developer Notes: Using raw malloc() and does not call error handlers since this may be used before PETSc is initialized. Used
38b4cd4cebSBarry Smith      to generate argc, args arguments passed to MPI_Init()
39301d30feSBarry Smith 
40b4cd4cebSBarry Smith .seealso: PetscStrToArrayDestroy(), PetscToken, PetscTokenCreate()
413c311c98SBarry Smith 
423c311c98SBarry Smith @*/
43d67fe73bSBarry Smith PetscErrorCode  PetscStrToArray(const char s[],char sp,int *argc,char ***args)
443c311c98SBarry Smith {
453c311c98SBarry Smith   int        i,n,*lens,cnt = 0;
46ace3abfcSBarry Smith   PetscBool  flg = PETSC_FALSE;
473c311c98SBarry Smith 
4840a7e1efSBarry Smith   if (!s) n = 0;
4940a7e1efSBarry Smith   else    n = strlen(s);
503c311c98SBarry Smith   *argc = 0;
51*4996c5bdSBarry Smith   if (!n) {
52*4996c5bdSBarry Smith     *args = 0;
53*4996c5bdSBarry Smith     return(0);
54*4996c5bdSBarry Smith   }
553c311c98SBarry Smith   for (i=0; i<n; i++) {
56d67fe73bSBarry Smith     if (s[i] != sp) break;
573c311c98SBarry Smith   }
583c311c98SBarry Smith   for (;i<n+1; i++) {
59d67fe73bSBarry Smith     if ((s[i] == sp || s[i] == 0) && !flg) {flg = PETSC_TRUE; (*argc)++;}
60d67fe73bSBarry Smith     else if (s[i] != sp) {flg = PETSC_FALSE;}
613c311c98SBarry Smith   }
62301d30feSBarry Smith   (*args) = (char **) malloc(((*argc)+1)*sizeof(char**)); if (!*args) return PETSC_ERR_MEM;
6353e6e2c4SHong Zhang   lens    = (int*) malloc((*argc)*sizeof(int)); if (!lens) return PETSC_ERR_MEM;
643c311c98SBarry Smith   for (i=0; i<*argc; i++) lens[i] = 0;
653c311c98SBarry Smith 
663c311c98SBarry Smith   *argc = 0;
673c311c98SBarry Smith   for (i=0; i<n; i++) {
68d67fe73bSBarry Smith     if (s[i] != sp) break;
693c311c98SBarry Smith   }
703c311c98SBarry Smith   for (;i<n+1; i++) {
71d67fe73bSBarry Smith     if ((s[i] == sp || s[i] == 0) && !flg) {flg = PETSC_TRUE; (*argc)++;}
72d67fe73bSBarry Smith     else if (s[i] != sp) {lens[*argc]++;flg = PETSC_FALSE;}
733c311c98SBarry Smith   }
743c311c98SBarry Smith 
753c311c98SBarry Smith   for (i=0; i<*argc; i++) {
76675282fdSHong Zhang     (*args)[i] = (char*) malloc((lens[i]+1)*sizeof(char)); if (!(*args)[i]) return PETSC_ERR_MEM;
773c311c98SBarry Smith   }
78301d30feSBarry Smith   (*args)[*argc] = 0;
793c311c98SBarry Smith 
803c311c98SBarry Smith   *argc = 0;
813c311c98SBarry Smith   for (i=0; i<n; i++) {
82d67fe73bSBarry Smith     if (s[i] != sp) break;
833c311c98SBarry Smith   }
843c311c98SBarry Smith   for (;i<n+1; i++) {
85d67fe73bSBarry Smith     if ((s[i] == sp || s[i] == 0) && !flg) {flg = PETSC_TRUE; (*args)[*argc][cnt++] = 0; (*argc)++; cnt = 0;}
86d67fe73bSBarry Smith     else if (s[i] != sp && s[i] != 0) {(*args)[*argc][cnt++] = s[i]; flg = PETSC_FALSE;}
873c311c98SBarry Smith   }
883c311c98SBarry Smith   return 0;
893c311c98SBarry Smith }
903c311c98SBarry Smith 
913c311c98SBarry Smith #undef __FUNCT__
92301d30feSBarry Smith #define __FUNCT__ "PetscStrToArrayDestroy"
93301d30feSBarry Smith /*@C
94301d30feSBarry Smith    PetscStrToArrayDestroy - Frees array created with PetscStrToArray().
95301d30feSBarry Smith 
96301d30feSBarry Smith    Not Collective
97301d30feSBarry Smith 
98301d30feSBarry Smith    Output Parameters:
99301d30feSBarry Smith +  argc - the number of arguments
100301d30feSBarry Smith -  args - the array of arguments
101301d30feSBarry Smith 
102301d30feSBarry Smith    Level: intermediate
103301d30feSBarry Smith 
104301d30feSBarry Smith    Concepts: command line arguments
105301d30feSBarry Smith 
106301d30feSBarry Smith    Notes: This may be called before PetscInitialize() or after PetscFinalize()
107301d30feSBarry Smith 
1086f013253SBarry Smith    Not for use in Fortran
1096f013253SBarry Smith 
110301d30feSBarry Smith .seealso: PetscStrToArray()
111301d30feSBarry Smith 
112301d30feSBarry Smith @*/
1137087cfbeSBarry Smith PetscErrorCode  PetscStrToArrayDestroy(int argc,char **args)
114301d30feSBarry Smith {
115301d30feSBarry Smith   PetscInt i;
116301d30feSBarry Smith 
117301d30feSBarry Smith   for (i=0; i<argc; i++) {
118301d30feSBarry Smith     free(args[i]);
119301d30feSBarry Smith   }
120*4996c5bdSBarry Smith   if (args) {
121301d30feSBarry Smith     free(args);
122*4996c5bdSBarry Smith   }
123301d30feSBarry Smith   return 0;
124301d30feSBarry Smith }
125301d30feSBarry Smith 
126301d30feSBarry Smith #undef __FUNCT__
127e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrlen"
128e5c89e4eSSatish Balay /*@C
129e5c89e4eSSatish Balay    PetscStrlen - Gets length of a string
130e5c89e4eSSatish Balay 
131e5c89e4eSSatish Balay    Not Collective
132e5c89e4eSSatish Balay 
133e5c89e4eSSatish Balay    Input Parameters:
134e5c89e4eSSatish Balay .  s - pointer to string
135e5c89e4eSSatish Balay 
136e5c89e4eSSatish Balay    Output Parameter:
137e5c89e4eSSatish Balay .  len - length in bytes
138e5c89e4eSSatish Balay 
139e5c89e4eSSatish Balay    Level: intermediate
140e5c89e4eSSatish Balay 
141e5c89e4eSSatish Balay    Note:
142e5c89e4eSSatish Balay    This routine is analogous to strlen().
143e5c89e4eSSatish Balay 
144e5c89e4eSSatish Balay    Null string returns a length of zero
145e5c89e4eSSatish Balay 
1466f013253SBarry Smith    Not for use in Fortran
1476f013253SBarry Smith 
148e5c89e4eSSatish Balay   Concepts: string length
149e5c89e4eSSatish Balay 
150e5c89e4eSSatish Balay @*/
1517087cfbeSBarry Smith PetscErrorCode  PetscStrlen(const char s[],size_t *len)
152e5c89e4eSSatish Balay {
153e5c89e4eSSatish Balay   PetscFunctionBegin;
154e5c89e4eSSatish Balay   if (!s) {
155e5c89e4eSSatish Balay     *len = 0;
156e5c89e4eSSatish Balay   } else {
157e5c89e4eSSatish Balay     *len = strlen(s);
158e5c89e4eSSatish Balay   }
159e5c89e4eSSatish Balay   PetscFunctionReturn(0);
160e5c89e4eSSatish Balay }
161e5c89e4eSSatish Balay 
162e5c89e4eSSatish Balay #undef __FUNCT__
163e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrallocpy"
164e5c89e4eSSatish Balay /*@C
165e5c89e4eSSatish Balay    PetscStrallocpy - Allocates space to hold a copy of a string then copies the string
166e5c89e4eSSatish Balay 
167e5c89e4eSSatish Balay    Not Collective
168e5c89e4eSSatish Balay 
169e5c89e4eSSatish Balay    Input Parameters:
170e5c89e4eSSatish Balay .  s - pointer to string
171e5c89e4eSSatish Balay 
172e5c89e4eSSatish Balay    Output Parameter:
173e5c89e4eSSatish Balay .  t - the copied string
174e5c89e4eSSatish Balay 
175e5c89e4eSSatish Balay    Level: intermediate
176e5c89e4eSSatish Balay 
177e5c89e4eSSatish Balay    Note:
178e5c89e4eSSatish Balay       Null string returns a new null string
179e5c89e4eSSatish Balay 
1806f013253SBarry Smith       Not for use in Fortran
1816f013253SBarry Smith 
182e5c89e4eSSatish Balay   Concepts: string copy
183e5c89e4eSSatish Balay 
184e5c89e4eSSatish Balay @*/
1857087cfbeSBarry Smith PetscErrorCode  PetscStrallocpy(const char s[],char *t[])
186e5c89e4eSSatish Balay {
187e5c89e4eSSatish Balay   PetscErrorCode ierr;
188e5c89e4eSSatish Balay   size_t         len;
18971573d7dSBarry Smith   char           *tmp = 0;
190e5c89e4eSSatish Balay 
191e5c89e4eSSatish Balay   PetscFunctionBegin;
192e5c89e4eSSatish Balay   if (s) {
193e5c89e4eSSatish Balay     ierr = PetscStrlen(s,&len);CHKERRQ(ierr);
19471573d7dSBarry Smith     ierr = PetscMalloc((1+len)*sizeof(char),&tmp);CHKERRQ(ierr);
19571573d7dSBarry Smith     ierr = PetscStrcpy(tmp,s);CHKERRQ(ierr);
196e5c89e4eSSatish Balay   }
19771573d7dSBarry Smith   *t = tmp;
198e5c89e4eSSatish Balay   PetscFunctionReturn(0);
199e5c89e4eSSatish Balay }
200e5c89e4eSSatish Balay 
201e5c89e4eSSatish Balay #undef __FUNCT__
20247340559SBarry Smith #define __FUNCT__ "PetscStrArrayallocpy"
20347340559SBarry Smith /*@C
20447340559SBarry Smith    PetscStrArrayallocpy - Allocates space to hold a copy of an array of strings then copies the strings
20547340559SBarry Smith 
20647340559SBarry Smith    Not Collective
20747340559SBarry Smith 
20847340559SBarry Smith    Input Parameters:
20947340559SBarry Smith .  s - pointer to array of strings (final string is a null)
21047340559SBarry Smith 
21147340559SBarry Smith    Output Parameter:
21247340559SBarry Smith .  t - the copied array string
21347340559SBarry Smith 
21447340559SBarry Smith    Level: intermediate
21547340559SBarry Smith 
21647340559SBarry Smith    Note:
21747340559SBarry Smith       Not for use in Fortran
21847340559SBarry Smith 
21947340559SBarry Smith   Concepts: string copy
22047340559SBarry Smith 
22147340559SBarry Smith .seealso: PetscStrallocpy() PetscStrArrayDestroy()
22247340559SBarry Smith 
22347340559SBarry Smith @*/
22447340559SBarry Smith PetscErrorCode  PetscStrArrayallocpy(const char *const*list,char ***t)
22547340559SBarry Smith {
22647340559SBarry Smith   PetscErrorCode ierr;
22747340559SBarry Smith   PetscInt       i,n = 0;
22847340559SBarry Smith 
22947340559SBarry Smith   PetscFunctionBegin;
23047340559SBarry Smith   while (list[n++]) ;
23147340559SBarry Smith   ierr = PetscMalloc((n+1)*sizeof(char**),t);CHKERRQ(ierr);
23247340559SBarry Smith   for (i=0; i<n; i++) {
23347340559SBarry Smith     ierr = PetscStrallocpy(list[i],(*t)+i);CHKERRQ(ierr);
23447340559SBarry Smith   }
23547340559SBarry Smith   (*t)[n] = PETSC_NULL;
23647340559SBarry Smith   PetscFunctionReturn(0);
23747340559SBarry Smith }
23847340559SBarry Smith 
23947340559SBarry Smith #undef __FUNCT__
24047340559SBarry Smith #define __FUNCT__ "PetscStrArrayDestroy"
24147340559SBarry Smith /*@C
24247340559SBarry Smith    PetscStrArrayDestroy - Frees array of strings created with PetscStrArrayallocpy().
24347340559SBarry Smith 
24447340559SBarry Smith    Not Collective
24547340559SBarry Smith 
24647340559SBarry Smith    Output Parameters:
24747340559SBarry Smith .   list - array of strings
24847340559SBarry Smith 
24947340559SBarry Smith    Level: intermediate
25047340559SBarry Smith 
25147340559SBarry Smith    Concepts: command line arguments
25247340559SBarry Smith 
25347340559SBarry Smith    Notes: Not for use in Fortran
25447340559SBarry Smith 
25547340559SBarry Smith .seealso: PetscStrArrayallocpy()
25647340559SBarry Smith 
25747340559SBarry Smith @*/
2586fed8037SJed Brown PetscErrorCode PetscStrArrayDestroy(char ***list)
25947340559SBarry Smith {
26047340559SBarry Smith   PetscInt       n = 0;
26147340559SBarry Smith   PetscErrorCode ierr;
26247340559SBarry Smith 
2636fed8037SJed Brown   PetscFunctionBegin;
2646fed8037SJed Brown   if (!*list) PetscFunctionReturn(0);
2656fed8037SJed Brown   while ((*list)[n]) {
2666fed8037SJed Brown     ierr = PetscFree((*list)[n]);CHKERRQ(ierr);
26747340559SBarry Smith     n++;
26847340559SBarry Smith   }
2696fed8037SJed Brown   ierr = PetscFree(*list);CHKERRQ(ierr);
2706fed8037SJed Brown   PetscFunctionReturn(0);
27147340559SBarry Smith }
27247340559SBarry Smith 
27347340559SBarry Smith #undef __FUNCT__
274e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrcpy"
275e5c89e4eSSatish Balay /*@C
276e5c89e4eSSatish Balay    PetscStrcpy - Copies a string
277e5c89e4eSSatish Balay 
278e5c89e4eSSatish Balay    Not Collective
279e5c89e4eSSatish Balay 
280e5c89e4eSSatish Balay    Input Parameters:
281e5c89e4eSSatish Balay .  t - pointer to string
282e5c89e4eSSatish Balay 
283e5c89e4eSSatish Balay    Output Parameter:
284e5c89e4eSSatish Balay .  s - the copied string
285e5c89e4eSSatish Balay 
286e5c89e4eSSatish Balay    Level: intermediate
287e5c89e4eSSatish Balay 
2886f013253SBarry Smith    Notes:
289e5c89e4eSSatish Balay      Null string returns a string starting with zero
290e5c89e4eSSatish Balay 
2916f013253SBarry Smith      Not for use in Fortran
2926f013253SBarry Smith 
293e5c89e4eSSatish Balay   Concepts: string copy
294e5c89e4eSSatish Balay 
295e5c89e4eSSatish Balay .seealso: PetscStrncpy(), PetscStrcat(), PetscStrncat()
296e5c89e4eSSatish Balay 
297e5c89e4eSSatish Balay @*/
298acc6cc86SBarry Smith 
2997087cfbeSBarry Smith PetscErrorCode  PetscStrcpy(char s[],const char t[])
300e5c89e4eSSatish Balay {
301e5c89e4eSSatish Balay   PetscFunctionBegin;
30217186662SBarry Smith   if (t && !s) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy string into null pointer");
303e5c89e4eSSatish Balay   if (t) {strcpy(s,t);}
304e5c89e4eSSatish Balay   else if (s) {s[0] = 0;}
305e5c89e4eSSatish Balay   PetscFunctionReturn(0);
306e5c89e4eSSatish Balay }
307e5c89e4eSSatish Balay 
308e5c89e4eSSatish Balay #undef __FUNCT__
309e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrncpy"
310e5c89e4eSSatish Balay /*@C
311e5c89e4eSSatish Balay    PetscStrncpy - Copies a string up to a certain length
312e5c89e4eSSatish Balay 
313e5c89e4eSSatish Balay    Not Collective
314e5c89e4eSSatish Balay 
315e5c89e4eSSatish Balay    Input Parameters:
316e5c89e4eSSatish Balay +  t - pointer to string
317e5c89e4eSSatish Balay -  n - the length to copy
318e5c89e4eSSatish Balay 
319e5c89e4eSSatish Balay    Output Parameter:
320e5c89e4eSSatish Balay .  s - the copied string
321e5c89e4eSSatish Balay 
322e5c89e4eSSatish Balay    Level: intermediate
323e5c89e4eSSatish Balay 
324e5c89e4eSSatish Balay    Note:
325e5c89e4eSSatish Balay      Null string returns a string starting with zero
326e5c89e4eSSatish Balay 
327e5c89e4eSSatish Balay   Concepts: string copy
328e5c89e4eSSatish Balay 
329e5c89e4eSSatish Balay .seealso: PetscStrcpy(), PetscStrcat(), PetscStrncat()
330e5c89e4eSSatish Balay 
331e5c89e4eSSatish Balay @*/
3327087cfbeSBarry Smith PetscErrorCode  PetscStrncpy(char s[],const char t[],size_t n)
333e5c89e4eSSatish Balay {
334e5c89e4eSSatish Balay   PetscFunctionBegin;
33517186662SBarry Smith   if (t && !s) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"Trying to copy string into null pointer");
336e5c89e4eSSatish Balay   if (t) {strncpy(s,t,n);}
337e5c89e4eSSatish Balay   else if (s) {s[0] = 0;}
338e5c89e4eSSatish Balay   PetscFunctionReturn(0);
339e5c89e4eSSatish Balay }
340e5c89e4eSSatish Balay 
341e5c89e4eSSatish Balay #undef __FUNCT__
342e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrcat"
343e5c89e4eSSatish Balay /*@C
344e5c89e4eSSatish Balay    PetscStrcat - Concatenates a string onto a given string
345e5c89e4eSSatish Balay 
346e5c89e4eSSatish Balay    Not Collective
347e5c89e4eSSatish Balay 
348e5c89e4eSSatish Balay    Input Parameters:
349e5e2177aSMatthew Knepley +  s - string to be added to
350e5e2177aSMatthew Knepley -  t - pointer to string to be added to end
351e5c89e4eSSatish Balay 
352e5c89e4eSSatish Balay    Level: intermediate
353e5c89e4eSSatish Balay 
3546f013253SBarry Smith    Notes: Not for use in Fortran
3556f013253SBarry Smith 
356e5c89e4eSSatish Balay   Concepts: string copy
357e5c89e4eSSatish Balay 
358e5c89e4eSSatish Balay .seealso: PetscStrcpy(), PetscStrncpy(), PetscStrncat()
359e5c89e4eSSatish Balay 
360e5c89e4eSSatish Balay @*/
3617087cfbeSBarry Smith PetscErrorCode  PetscStrcat(char s[],const char t[])
362e5c89e4eSSatish Balay {
363e5c89e4eSSatish Balay   PetscFunctionBegin;
3649b754dc9SBarry Smith   if (!t) PetscFunctionReturn(0);
365e5c89e4eSSatish Balay   strcat(s,t);
366e5c89e4eSSatish Balay   PetscFunctionReturn(0);
367e5c89e4eSSatish Balay }
368e5c89e4eSSatish Balay 
369e5c89e4eSSatish Balay #undef __FUNCT__
370e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrncat"
371e5c89e4eSSatish Balay /*@C
372e5c89e4eSSatish Balay    PetscStrncat - Concatenates a string onto a given string, up to a given length
373e5c89e4eSSatish Balay 
374e5c89e4eSSatish Balay    Not Collective
375e5c89e4eSSatish Balay 
376e5c89e4eSSatish Balay    Input Parameters:
377e5c89e4eSSatish Balay +  s - pointer to string to be added to end
378e5c89e4eSSatish Balay .  t - string to be added to
379e5c89e4eSSatish Balay .  n - maximum length to copy
380e5c89e4eSSatish Balay 
381e5c89e4eSSatish Balay    Level: intermediate
382e5c89e4eSSatish Balay 
3836f013253SBarry Smith   Notes:    Not for use in Fortran
3846f013253SBarry Smith 
385e5c89e4eSSatish Balay   Concepts: string copy
386e5c89e4eSSatish Balay 
387e5c89e4eSSatish Balay .seealso: PetscStrcpy(), PetscStrncpy(), PetscStrcat()
388e5c89e4eSSatish Balay 
389e5c89e4eSSatish Balay @*/
3907087cfbeSBarry Smith PetscErrorCode  PetscStrncat(char s[],const char t[],size_t n)
391e5c89e4eSSatish Balay {
392e5c89e4eSSatish Balay   PetscFunctionBegin;
393e5c89e4eSSatish Balay   strncat(s,t,n);
394e5c89e4eSSatish Balay   PetscFunctionReturn(0);
395e5c89e4eSSatish Balay }
396e5c89e4eSSatish Balay 
397e5c89e4eSSatish Balay #undef __FUNCT__
398e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrcmp"
399e5c89e4eSSatish Balay /*@C
400e5c89e4eSSatish Balay    PetscStrcmp - Compares two strings,
401e5c89e4eSSatish Balay 
402e5c89e4eSSatish Balay    Not Collective
403e5c89e4eSSatish Balay 
404e5c89e4eSSatish Balay    Input Parameters:
405e5c89e4eSSatish Balay +  a - pointer to string first string
406e5c89e4eSSatish Balay -  b - pointer to second string
407e5c89e4eSSatish Balay 
408e5c89e4eSSatish Balay    Output Parameter:
4098c74ee41SBarry Smith .  flg - PETSC_TRUE if the two strings are equal
410e5c89e4eSSatish Balay 
411e5c89e4eSSatish Balay    Level: intermediate
412e5c89e4eSSatish Balay 
4136f013253SBarry Smith    Notes:    Not for use in Fortran
4146f013253SBarry Smith 
415e5c89e4eSSatish Balay .seealso: PetscStrgrt(), PetscStrncmp(), PetscStrcasecmp()
416e5c89e4eSSatish Balay 
417e5c89e4eSSatish Balay @*/
4187087cfbeSBarry Smith PetscErrorCode  PetscStrcmp(const char a[],const char b[],PetscBool  *flg)
419e5c89e4eSSatish Balay {
420e5c89e4eSSatish Balay   int c;
421e5c89e4eSSatish Balay 
422e5c89e4eSSatish Balay   PetscFunctionBegin;
423e5c89e4eSSatish Balay   if (!a && !b) {
424e5c89e4eSSatish Balay     *flg = PETSC_TRUE;
425e5c89e4eSSatish Balay   } else if (!a || !b) {
426e5c89e4eSSatish Balay     *flg = PETSC_FALSE;
427e5c89e4eSSatish Balay   } else {
428e5c89e4eSSatish Balay     c = strcmp(a,b);
429e5c89e4eSSatish Balay     if (c) *flg = PETSC_FALSE;
430e5c89e4eSSatish Balay     else   *flg = PETSC_TRUE;
431e5c89e4eSSatish Balay   }
432e5c89e4eSSatish Balay   PetscFunctionReturn(0);
433e5c89e4eSSatish Balay }
434e5c89e4eSSatish Balay 
435e5c89e4eSSatish Balay #undef __FUNCT__
436e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrgrt"
437e5c89e4eSSatish Balay /*@C
438e5c89e4eSSatish Balay    PetscStrgrt - If first string is greater than the second
439e5c89e4eSSatish Balay 
440e5c89e4eSSatish Balay    Not Collective
441e5c89e4eSSatish Balay 
442e5c89e4eSSatish Balay    Input Parameters:
443e5c89e4eSSatish Balay +  a - pointer to first string
444e5c89e4eSSatish Balay -  b - pointer to second string
445e5c89e4eSSatish Balay 
446e5c89e4eSSatish Balay    Output Parameter:
447e5c89e4eSSatish Balay .  flg - if the first string is greater
448e5c89e4eSSatish Balay 
449e5c89e4eSSatish Balay    Notes:
450e5c89e4eSSatish Balay     Null arguments are ok, a null string is considered smaller than
451e5c89e4eSSatish Balay     all others
452e5c89e4eSSatish Balay 
4536f013253SBarry Smith    Not for use in Fortran
4546f013253SBarry Smith 
455e5c89e4eSSatish Balay    Level: intermediate
456e5c89e4eSSatish Balay 
457e5c89e4eSSatish Balay .seealso: PetscStrcmp(), PetscStrncmp(), PetscStrcasecmp()
458e5c89e4eSSatish Balay 
459e5c89e4eSSatish Balay @*/
4607087cfbeSBarry Smith PetscErrorCode  PetscStrgrt(const char a[],const char b[],PetscBool  *t)
461e5c89e4eSSatish Balay {
462e5c89e4eSSatish Balay   int c;
463e5c89e4eSSatish Balay 
464e5c89e4eSSatish Balay   PetscFunctionBegin;
465e5c89e4eSSatish Balay   if (!a && !b) {
466e5c89e4eSSatish Balay     *t = PETSC_FALSE;
467e5c89e4eSSatish Balay   } else if (a && !b) {
468e5c89e4eSSatish Balay     *t = PETSC_TRUE;
469e5c89e4eSSatish Balay   } else if (!a && b) {
470e5c89e4eSSatish Balay     *t = PETSC_FALSE;
471e5c89e4eSSatish Balay   } else {
472e5c89e4eSSatish Balay     c = strcmp(a,b);
473e5c89e4eSSatish Balay     if (c > 0) *t = PETSC_TRUE;
474e5c89e4eSSatish Balay     else       *t = PETSC_FALSE;
475e5c89e4eSSatish Balay   }
476e5c89e4eSSatish Balay   PetscFunctionReturn(0);
477e5c89e4eSSatish Balay }
478e5c89e4eSSatish Balay 
479e5c89e4eSSatish Balay #undef __FUNCT__
480e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrcasecmp"
481e5c89e4eSSatish Balay /*@C
482e5c89e4eSSatish Balay    PetscStrcasecmp - Returns true if the two strings are the same
483e5c89e4eSSatish Balay      except possibly for case.
484e5c89e4eSSatish Balay 
485e5c89e4eSSatish Balay    Not Collective
486e5c89e4eSSatish Balay 
487e5c89e4eSSatish Balay    Input Parameters:
488e5c89e4eSSatish Balay +  a - pointer to first string
489e5c89e4eSSatish Balay -  b - pointer to second string
490e5c89e4eSSatish Balay 
491e5c89e4eSSatish Balay    Output Parameter:
492e5c89e4eSSatish Balay .  flg - if the two strings are the same
493e5c89e4eSSatish Balay 
494e5c89e4eSSatish Balay    Notes:
495e5c89e4eSSatish Balay     Null arguments are ok
496e5c89e4eSSatish Balay 
4976f013253SBarry Smith    Not for use in Fortran
4986f013253SBarry Smith 
499e5c89e4eSSatish Balay    Level: intermediate
500e5c89e4eSSatish Balay 
501e5c89e4eSSatish Balay .seealso: PetscStrcmp(), PetscStrncmp(), PetscStrgrt()
502e5c89e4eSSatish Balay 
503e5c89e4eSSatish Balay @*/
5047087cfbeSBarry Smith PetscErrorCode  PetscStrcasecmp(const char a[],const char b[],PetscBool  *t)
505e5c89e4eSSatish Balay {
506e5c89e4eSSatish Balay   int c;
507e5c89e4eSSatish Balay 
508e5c89e4eSSatish Balay   PetscFunctionBegin;
509e5c89e4eSSatish Balay   if (!a && !b) c = 0;
510e5c89e4eSSatish Balay   else if (!a || !b) c = 1;
51132b366c8SSatish Balay #if defined(PETSC_HAVE_STRCASECMP)
51232b366c8SSatish Balay   else c = strcasecmp(a,b);
51332b366c8SSatish Balay #elif defined(PETSC_HAVE_STRICMP)
514e5c89e4eSSatish Balay   else c = stricmp(a,b);
515e5c89e4eSSatish Balay #else
51632b366c8SSatish Balay   else {
51732b366c8SSatish Balay     char           *aa,*bb;
51832b366c8SSatish Balay     PetscErrorCode ierr;
51932b366c8SSatish Balay     ierr = PetscStrallocpy(a,&aa);CHKERRQ(ierr);
52032b366c8SSatish Balay     ierr = PetscStrallocpy(b,&bb);CHKERRQ(ierr);
52132b366c8SSatish Balay     ierr = PetscStrtolower(aa);CHKERRQ(ierr);
52232b366c8SSatish Balay     ierr = PetscStrtolower(bb);CHKERRQ(ierr);
52332b366c8SSatish Balay     ierr = PetscStrcmp(aa,bb,t);CHKERRQ(ierr);
524503cfb0cSBarry Smith     ierr = PetscFree(aa);CHKERRQ(ierr);
525503cfb0cSBarry Smith     ierr = PetscFree(bb);CHKERRQ(ierr);
52632b366c8SSatish Balay     PetscFunctionReturn(0);
52732b366c8SSatish Balay   }
528e5c89e4eSSatish Balay #endif
529e5c89e4eSSatish Balay   if (!c) *t = PETSC_TRUE;
530e5c89e4eSSatish Balay   else    *t = PETSC_FALSE;
531e5c89e4eSSatish Balay   PetscFunctionReturn(0);
532e5c89e4eSSatish Balay }
533e5c89e4eSSatish Balay 
53432b366c8SSatish Balay 
53532b366c8SSatish Balay 
536e5c89e4eSSatish Balay #undef __FUNCT__
537e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrncmp"
538e5c89e4eSSatish Balay /*@C
539e5c89e4eSSatish Balay    PetscStrncmp - Compares two strings, up to a certain length
540e5c89e4eSSatish Balay 
541e5c89e4eSSatish Balay    Not Collective
542e5c89e4eSSatish Balay 
543e5c89e4eSSatish Balay    Input Parameters:
544e5c89e4eSSatish Balay +  a - pointer to first string
545e5c89e4eSSatish Balay .  b - pointer to second string
546e5c89e4eSSatish Balay -  n - length to compare up to
547e5c89e4eSSatish Balay 
548e5c89e4eSSatish Balay    Output Parameter:
549e5c89e4eSSatish Balay .  t - if the two strings are equal
550e5c89e4eSSatish Balay 
551e5c89e4eSSatish Balay    Level: intermediate
552e5c89e4eSSatish Balay 
5536f013253SBarry Smith    Notes:    Not for use in Fortran
5546f013253SBarry Smith 
555e5c89e4eSSatish Balay .seealso: PetscStrgrt(), PetscStrcmp(), PetscStrcasecmp()
556e5c89e4eSSatish Balay 
557e5c89e4eSSatish Balay @*/
5587087cfbeSBarry Smith PetscErrorCode  PetscStrncmp(const char a[],const char b[],size_t n,PetscBool  *t)
559e5c89e4eSSatish Balay {
560e5c89e4eSSatish Balay   int c;
561e5c89e4eSSatish Balay 
562e5c89e4eSSatish Balay   PetscFunctionBegin;
563e5c89e4eSSatish Balay   c = strncmp(a,b,n);
564e5c89e4eSSatish Balay   if (!c) *t = PETSC_TRUE;
565e5c89e4eSSatish Balay   else    *t = PETSC_FALSE;
566e5c89e4eSSatish Balay   PetscFunctionReturn(0);
567e5c89e4eSSatish Balay }
568e5c89e4eSSatish Balay 
569e5c89e4eSSatish Balay #undef __FUNCT__
570e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrchr"
571e5c89e4eSSatish Balay /*@C
572e5c89e4eSSatish Balay    PetscStrchr - Locates first occurance of a character in a string
573e5c89e4eSSatish Balay 
574e5c89e4eSSatish Balay    Not Collective
575e5c89e4eSSatish Balay 
576e5c89e4eSSatish Balay    Input Parameters:
577e5c89e4eSSatish Balay +  a - pointer to string
578e5c89e4eSSatish Balay -  b - character
579e5c89e4eSSatish Balay 
580e5c89e4eSSatish Balay    Output Parameter:
581e5c89e4eSSatish Balay .  c - location of occurance, PETSC_NULL if not found
582e5c89e4eSSatish Balay 
583e5c89e4eSSatish Balay    Level: intermediate
584e5c89e4eSSatish Balay 
5856f013253SBarry Smith    Notes:    Not for use in Fortran
5866f013253SBarry Smith 
587e5c89e4eSSatish Balay @*/
5887087cfbeSBarry Smith PetscErrorCode  PetscStrchr(const char a[],char b,char *c[])
589e5c89e4eSSatish Balay {
590e5c89e4eSSatish Balay   PetscFunctionBegin;
591e5c89e4eSSatish Balay   *c = (char *)strchr(a,b);
592e5c89e4eSSatish Balay   PetscFunctionReturn(0);
593e5c89e4eSSatish Balay }
594e5c89e4eSSatish Balay 
595e5c89e4eSSatish Balay #undef __FUNCT__
596e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrrchr"
597e5c89e4eSSatish Balay /*@C
598e5c89e4eSSatish Balay    PetscStrrchr - Locates one location past the last occurance of a character in a string,
599e5c89e4eSSatish Balay       if the character is not found then returns entire string
600e5c89e4eSSatish Balay 
601e5c89e4eSSatish Balay    Not Collective
602e5c89e4eSSatish Balay 
603e5c89e4eSSatish Balay    Input Parameters:
604e5c89e4eSSatish Balay +  a - pointer to string
605e5c89e4eSSatish Balay -  b - character
606e5c89e4eSSatish Balay 
607e5c89e4eSSatish Balay    Output Parameter:
608e5c89e4eSSatish Balay .  tmp - location of occurance, a if not found
609e5c89e4eSSatish Balay 
610e5c89e4eSSatish Balay    Level: intermediate
611e5c89e4eSSatish Balay 
6126f013253SBarry Smith    Notes:    Not for use in Fortran
6136f013253SBarry Smith 
614e5c89e4eSSatish Balay @*/
6157087cfbeSBarry Smith PetscErrorCode  PetscStrrchr(const char a[],char b,char *tmp[])
616e5c89e4eSSatish Balay {
617e5c89e4eSSatish Balay   PetscFunctionBegin;
618e5c89e4eSSatish Balay   *tmp = (char *)strrchr(a,b);
619e5c89e4eSSatish Balay   if (!*tmp) *tmp = (char*)a; else *tmp = *tmp + 1;
620e5c89e4eSSatish Balay   PetscFunctionReturn(0);
621e5c89e4eSSatish Balay }
622e5c89e4eSSatish Balay 
623e5c89e4eSSatish Balay #undef __FUNCT__
624e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrtolower"
625e5c89e4eSSatish Balay /*@C
626e5c89e4eSSatish Balay    PetscStrtolower - Converts string to lower case
627e5c89e4eSSatish Balay 
628e5c89e4eSSatish Balay    Not Collective
629e5c89e4eSSatish Balay 
630e5c89e4eSSatish Balay    Input Parameters:
631e5c89e4eSSatish Balay .  a - pointer to string
632e5c89e4eSSatish Balay 
633e5c89e4eSSatish Balay    Level: intermediate
634e5c89e4eSSatish Balay 
6356f013253SBarry Smith    Notes:    Not for use in Fortran
6366f013253SBarry Smith 
637e5c89e4eSSatish Balay @*/
6387087cfbeSBarry Smith PetscErrorCode  PetscStrtolower(char a[])
639e5c89e4eSSatish Balay {
640e5c89e4eSSatish Balay   PetscFunctionBegin;
641e5c89e4eSSatish Balay   while (*a) {
642e5c89e4eSSatish Balay     if (*a >= 'A' && *a <= 'Z') *a += 'a' - 'A';
643e5c89e4eSSatish Balay     a++;
644e5c89e4eSSatish Balay   }
645e5c89e4eSSatish Balay   PetscFunctionReturn(0);
646e5c89e4eSSatish Balay }
647e5c89e4eSSatish Balay 
6487ba3a57cSBarry Smith #undef __FUNCT__
6497ba3a57cSBarry Smith #define __FUNCT__ "PetscStrendswith"
6507ba3a57cSBarry Smith /*@C
6517ba3a57cSBarry Smith    PetscStrendswith - Determines if a string ends with a certain string
6521d1a0024SBarry Smith 
6537ba3a57cSBarry Smith    Not Collective
6547ba3a57cSBarry Smith 
6557ba3a57cSBarry Smith    Input Parameters:
6567ba3a57cSBarry Smith +  a - pointer to string
6577ba3a57cSBarry Smith -  b - string to endwith
6587ba3a57cSBarry Smith 
6597ba3a57cSBarry Smith    Output Parameter:
6607ba3a57cSBarry Smith .  flg - PETSC_TRUE or PETSC_FALSE
6617ba3a57cSBarry Smith 
6627ba3a57cSBarry Smith    Notes:     Not for use in Fortran
6637ba3a57cSBarry Smith 
6647ba3a57cSBarry Smith    Level: intermediate
6657ba3a57cSBarry Smith 
6667ba3a57cSBarry Smith @*/
6677ba3a57cSBarry Smith PetscErrorCode  PetscStrendswith(const char a[],const char b[],PetscBool *flg)
6687ba3a57cSBarry Smith {
6697ba3a57cSBarry Smith   char           *test;
6707ba3a57cSBarry Smith   PetscErrorCode ierr;
6717ba3a57cSBarry Smith   size_t         na,nb;
6727ba3a57cSBarry Smith 
6737ba3a57cSBarry Smith   PetscFunctionBegin;
6747ba3a57cSBarry Smith   *flg = PETSC_FALSE;
6757ba3a57cSBarry Smith   ierr = PetscStrrstr(a,b,&test);CHKERRQ(ierr);
6767ba3a57cSBarry Smith   if (test) {
6777ba3a57cSBarry Smith     ierr = PetscStrlen(a,&na);CHKERRQ(ierr);
6787ba3a57cSBarry Smith     ierr = PetscStrlen(b,&nb);CHKERRQ(ierr);
6797ba3a57cSBarry Smith     if (a+na-nb == test) *flg = PETSC_TRUE;
6807ba3a57cSBarry Smith   }
6817ba3a57cSBarry Smith   PetscFunctionReturn(0);
6827ba3a57cSBarry Smith }
6837ba3a57cSBarry Smith 
6847ba3a57cSBarry Smith #undef __FUNCT__
6857ba3a57cSBarry Smith #define __FUNCT__ "PetscStrendswithwhich"
6867ba3a57cSBarry Smith /*@C
6877ba3a57cSBarry Smith    PetscStrendswithwhich - Determines if a string ends with one of several possible strings
6887ba3a57cSBarry Smith 
6897ba3a57cSBarry Smith    Not Collective
6907ba3a57cSBarry Smith 
6917ba3a57cSBarry Smith    Input Parameters:
6927ba3a57cSBarry Smith +  a - pointer to string
6937ba3a57cSBarry Smith -  bs - strings to endwith (last entry must be null)
6947ba3a57cSBarry Smith 
6957ba3a57cSBarry Smith    Output Parameter:
6967ba3a57cSBarry Smith .  cnt - the index of the string it ends with or 1+the last possible index
6977ba3a57cSBarry Smith 
6987ba3a57cSBarry Smith    Notes:     Not for use in Fortran
6997ba3a57cSBarry Smith 
7007ba3a57cSBarry Smith    Level: intermediate
7017ba3a57cSBarry Smith 
7027ba3a57cSBarry Smith @*/
7037ba3a57cSBarry Smith PetscErrorCode  PetscStrendswithwhich(const char a[],const char *const *bs,PetscInt *cnt)
7047ba3a57cSBarry Smith {
7057ba3a57cSBarry Smith   PetscBool      flg;
7067ba3a57cSBarry Smith   PetscErrorCode ierr;
7077ba3a57cSBarry Smith 
7087ba3a57cSBarry Smith   PetscFunctionBegin;
7097ba3a57cSBarry Smith   *cnt = 0;
7107ba3a57cSBarry Smith   while (bs[*cnt]) {
7117ba3a57cSBarry Smith     ierr = PetscStrendswith(a,bs[*cnt],&flg);CHKERRQ(ierr);
7127ba3a57cSBarry Smith     if (flg) PetscFunctionReturn(0);
7137ba3a57cSBarry Smith     *cnt += 1;
7147ba3a57cSBarry Smith   }
7157ba3a57cSBarry Smith   PetscFunctionReturn(0);
7167ba3a57cSBarry Smith }
7177ba3a57cSBarry Smith 
7187ba3a57cSBarry Smith #undef __FUNCT__
7197ba3a57cSBarry Smith #define __FUNCT__ "PetscStrrstr"
7207ba3a57cSBarry Smith /*@C
7217ba3a57cSBarry Smith    PetscStrrstr - Locates last occurance of string in another string
7227ba3a57cSBarry Smith 
7237ba3a57cSBarry Smith    Not Collective
7247ba3a57cSBarry Smith 
7257ba3a57cSBarry Smith    Input Parameters:
7267ba3a57cSBarry Smith +  a - pointer to string
7277ba3a57cSBarry Smith -  b - string to find
7287ba3a57cSBarry Smith 
7297ba3a57cSBarry Smith    Output Parameter:
7307ba3a57cSBarry Smith .  tmp - location of occurance
7317ba3a57cSBarry Smith 
7327ba3a57cSBarry Smith    Notes:     Not for use in Fortran
7337ba3a57cSBarry Smith 
7347ba3a57cSBarry Smith    Level: intermediate
7357ba3a57cSBarry Smith 
7367ba3a57cSBarry Smith @*/
7377ba3a57cSBarry Smith PetscErrorCode  PetscStrrstr(const char a[],const char b[],char *tmp[])
7387ba3a57cSBarry Smith {
7397ba3a57cSBarry Smith   const char *stmp = a, *ltmp = 0;
7407ba3a57cSBarry Smith 
7417ba3a57cSBarry Smith   PetscFunctionBegin;
7427ba3a57cSBarry Smith   while (stmp) {
7437ba3a57cSBarry Smith     stmp = (char *)strstr(stmp,b);
7447ba3a57cSBarry Smith     if (stmp) {ltmp = stmp;stmp++;}
7457ba3a57cSBarry Smith   }
7467ba3a57cSBarry Smith   *tmp = (char *)ltmp;
7477ba3a57cSBarry Smith   PetscFunctionReturn(0);
7487ba3a57cSBarry Smith }
7497ba3a57cSBarry Smith 
7507ba3a57cSBarry Smith #undef __FUNCT__
7517ba3a57cSBarry Smith #define __FUNCT__ "PetscStrstr"
7527ba3a57cSBarry Smith /*@C
7537ba3a57cSBarry Smith    PetscStrstr - Locates first occurance of string in another string
7547ba3a57cSBarry Smith 
7557ba3a57cSBarry Smith    Not Collective
7567ba3a57cSBarry Smith 
7577ba3a57cSBarry Smith    Input Parameters:
758160f4796SJed Brown +  haystack - string to search
759160f4796SJed Brown -  needle - string to find
7607ba3a57cSBarry Smith 
7617ba3a57cSBarry Smith    Output Parameter:
7627ba3a57cSBarry Smith .  tmp - location of occurance, is a PETSC_NULL if the string is not found
7637ba3a57cSBarry Smith 
7647ba3a57cSBarry Smith    Notes: Not for use in Fortran
7657ba3a57cSBarry Smith 
7667ba3a57cSBarry Smith    Level: intermediate
7677ba3a57cSBarry Smith 
7687ba3a57cSBarry Smith @*/
769160f4796SJed Brown PetscErrorCode  PetscStrstr(const char haystack[],const char needle[],char *tmp[])
7707ba3a57cSBarry Smith {
7717ba3a57cSBarry Smith   PetscFunctionBegin;
772160f4796SJed Brown   *tmp = (char *)strstr(haystack,needle);
7737ba3a57cSBarry Smith   PetscFunctionReturn(0);
7747ba3a57cSBarry Smith }
7757ba3a57cSBarry Smith 
7767ba3a57cSBarry Smith struct _p_PetscToken {char token;char *array;char *current;};
7771d1a0024SBarry Smith 
778e5c89e4eSSatish Balay #undef __FUNCT__
779e5c89e4eSSatish Balay #define __FUNCT__ "PetscTokenFind"
780e5c89e4eSSatish Balay /*@C
781e5c89e4eSSatish Balay    PetscTokenFind - Locates next "token" in a string
782e5c89e4eSSatish Balay 
783e5c89e4eSSatish Balay    Not Collective
784e5c89e4eSSatish Balay 
785e5c89e4eSSatish Balay    Input Parameters:
786e5c89e4eSSatish Balay .  a - pointer to token
787e5c89e4eSSatish Balay 
788e5c89e4eSSatish Balay    Output Parameter:
789e5c89e4eSSatish Balay .  result - location of occurance, PETSC_NULL if not found
790e5c89e4eSSatish Balay 
791e5c89e4eSSatish Balay    Notes:
792e5c89e4eSSatish Balay 
793e5c89e4eSSatish Balay      This version is different from the system version in that
794e5c89e4eSSatish Balay   it allows you to pass a read-only string into the function.
795e5c89e4eSSatish Balay 
7964704e885SBarry Smith      This version also treats all characters etc. inside a double quote "
7974704e885SBarry Smith    as a single token.
7984704e885SBarry Smith 
7996f013253SBarry Smith     Not for use in Fortran
8006f013253SBarry Smith 
801e5c89e4eSSatish Balay    Level: intermediate
802e5c89e4eSSatish Balay 
8036f013253SBarry Smith 
804e5c89e4eSSatish Balay .seealso: PetscTokenCreate(), PetscTokenDestroy()
805e5c89e4eSSatish Balay @*/
8067087cfbeSBarry Smith PetscErrorCode  PetscTokenFind(PetscToken a,char *result[])
807e5c89e4eSSatish Balay {
8084704e885SBarry Smith   char *ptr = a->current,token;
809e5c89e4eSSatish Balay 
810e5c89e4eSSatish Balay   PetscFunctionBegin;
811e5c89e4eSSatish Balay   *result = a->current;
8124704e885SBarry Smith   if (ptr && !*ptr) {*result = 0;PetscFunctionReturn(0);}
8134704e885SBarry Smith   token = a->token;
81490fdf44cSMatthew Knepley   if (ptr && (*ptr == '"')) {token = '"';(*result)++;ptr++;}
815e5c89e4eSSatish Balay   while (ptr) {
8164704e885SBarry Smith     if (*ptr == token) {
817e5c89e4eSSatish Balay       *ptr++ = 0;
818e5c89e4eSSatish Balay       while (*ptr == a->token) ptr++;
819e5c89e4eSSatish Balay       a->current = ptr;
820e5c89e4eSSatish Balay       break;
821e5c89e4eSSatish Balay     }
822e5c89e4eSSatish Balay     if (!*ptr) {
823e5c89e4eSSatish Balay       a->current = 0;
824e5c89e4eSSatish Balay       break;
825e5c89e4eSSatish Balay     }
826e5c89e4eSSatish Balay     ptr++;
827e5c89e4eSSatish Balay   }
828e5c89e4eSSatish Balay   PetscFunctionReturn(0);
829e5c89e4eSSatish Balay }
830e5c89e4eSSatish Balay 
831e5c89e4eSSatish Balay #undef __FUNCT__
832e5c89e4eSSatish Balay #define __FUNCT__ "PetscTokenCreate"
833e5c89e4eSSatish Balay /*@C
834e5c89e4eSSatish Balay    PetscTokenCreate - Creates a PetscToken used to find tokens in a string
835e5c89e4eSSatish Balay 
836e5c89e4eSSatish Balay    Not Collective
837e5c89e4eSSatish Balay 
838e5c89e4eSSatish Balay    Input Parameters:
839e5c89e4eSSatish Balay +  string - the string to look in
840e5c89e4eSSatish Balay -  token - the character to look for
841e5c89e4eSSatish Balay 
842e5c89e4eSSatish Balay    Output Parameter:
843e5c89e4eSSatish Balay .  a - pointer to token
844e5c89e4eSSatish Balay 
845e5c89e4eSSatish Balay    Notes:
846e5c89e4eSSatish Balay 
847e5c89e4eSSatish Balay      This version is different from the system version in that
848e5c89e4eSSatish Balay   it allows you to pass a read-only string into the function.
849e5c89e4eSSatish Balay 
8506f013253SBarry Smith     Not for use in Fortran
8516f013253SBarry Smith 
852e5c89e4eSSatish Balay    Level: intermediate
853e5c89e4eSSatish Balay 
854e5c89e4eSSatish Balay .seealso: PetscTokenFind(), PetscTokenDestroy()
855e5c89e4eSSatish Balay @*/
8567087cfbeSBarry Smith PetscErrorCode  PetscTokenCreate(const char a[],const char b,PetscToken *t)
857e5c89e4eSSatish Balay {
858e5c89e4eSSatish Balay   PetscErrorCode ierr;
859e5c89e4eSSatish Balay 
860e5c89e4eSSatish Balay   PetscFunctionBegin;
8611d1a0024SBarry Smith   ierr = PetscNew(struct _p_PetscToken,t);CHKERRQ(ierr);
862e5c89e4eSSatish Balay   ierr = PetscStrallocpy(a,&(*t)->array);CHKERRQ(ierr);
863e5c89e4eSSatish Balay   (*t)->current = (*t)->array;
864e5c89e4eSSatish Balay   (*t)->token   = b;
865e5c89e4eSSatish Balay   PetscFunctionReturn(0);
866e5c89e4eSSatish Balay }
867e5c89e4eSSatish Balay 
868e5c89e4eSSatish Balay #undef __FUNCT__
869e5c89e4eSSatish Balay #define __FUNCT__ "PetscTokenDestroy"
870e5c89e4eSSatish Balay /*@C
871e5c89e4eSSatish Balay    PetscTokenDestroy - Destroys a PetscToken
872e5c89e4eSSatish Balay 
873e5c89e4eSSatish Balay    Not Collective
874e5c89e4eSSatish Balay 
875e5c89e4eSSatish Balay    Input Parameters:
876e5c89e4eSSatish Balay .  a - pointer to token
877e5c89e4eSSatish Balay 
878e5c89e4eSSatish Balay    Level: intermediate
879e5c89e4eSSatish Balay 
8806f013253SBarry Smith    Notes:     Not for use in Fortran
8816f013253SBarry Smith 
882e5c89e4eSSatish Balay .seealso: PetscTokenCreate(), PetscTokenFind()
883e5c89e4eSSatish Balay @*/
8848c74ee41SBarry Smith PetscErrorCode  PetscTokenDestroy(PetscToken *a)
885e5c89e4eSSatish Balay {
886e5c89e4eSSatish Balay   PetscErrorCode ierr;
887e5c89e4eSSatish Balay 
888e5c89e4eSSatish Balay   PetscFunctionBegin;
8898c74ee41SBarry Smith   if (!*a) PetscFunctionReturn(0);
8908c74ee41SBarry Smith   ierr = PetscFree((*a)->array);CHKERRQ(ierr);
8918c74ee41SBarry Smith   ierr = PetscFree(*a);CHKERRQ(ierr);
892e5c89e4eSSatish Balay   PetscFunctionReturn(0);
893e5c89e4eSSatish Balay }
894e5c89e4eSSatish Balay 
895e5c89e4eSSatish Balay 
896e5c89e4eSSatish Balay #undef __FUNCT__
897e5c89e4eSSatish Balay #define __FUNCT__ "PetscGetPetscDir"
898e5c89e4eSSatish Balay /*@C
899e5c89e4eSSatish Balay    PetscGetPetscDir - Gets the directory PETSc is installed in
900e5c89e4eSSatish Balay 
901e5c89e4eSSatish Balay    Not Collective
902e5c89e4eSSatish Balay 
903e5c89e4eSSatish Balay    Output Parameter:
904e5c89e4eSSatish Balay .  dir - the directory
905e5c89e4eSSatish Balay 
906e5c89e4eSSatish Balay    Level: developer
907e5c89e4eSSatish Balay 
9086f013253SBarry Smith    Notes: Not for use in Fortran
9096f013253SBarry Smith 
910e5c89e4eSSatish Balay @*/
9117087cfbeSBarry Smith PetscErrorCode  PetscGetPetscDir(const char *dir[])
912e5c89e4eSSatish Balay {
913e5c89e4eSSatish Balay   PetscFunctionBegin;
914e5c89e4eSSatish Balay   *dir = PETSC_DIR;
915e5c89e4eSSatish Balay   PetscFunctionReturn(0);
916e5c89e4eSSatish Balay }
917e5c89e4eSSatish Balay 
918e5c89e4eSSatish Balay #undef __FUNCT__
919e5c89e4eSSatish Balay #define __FUNCT__ "PetscStrreplace"
920e5c89e4eSSatish Balay /*@C
921e5c89e4eSSatish Balay    PetscStrreplace - Replaces substrings in string with other substrings
922e5c89e4eSSatish Balay 
923e5c89e4eSSatish Balay    Not Collective
924e5c89e4eSSatish Balay 
925e5c89e4eSSatish Balay    Input Parameters:
926e5c89e4eSSatish Balay +   comm - MPI_Comm of processors that are processing the string
92771573d7dSBarry Smith .   aa - the string to look in
928d8ccf1fbSBarry Smith .   b - the resulting copy of a with replaced strings (b can be the same as a)
929e5c89e4eSSatish Balay -   len - the length of b
930e5c89e4eSSatish Balay 
931e5c89e4eSSatish Balay    Notes:
932e5c89e4eSSatish Balay       Replaces   ${PETSC_ARCH},${PETSC_DIR},${PETSC_LIB_DIR},${DISPLAY},
933d5649816SBarry Smith       ${HOMEDIRECTORY},${WORKINGDIRECTORY},${USERNAME}, ${HOSTNAME} with appropriate values
934e5c89e4eSSatish Balay       as well as any environmental variables.
935e5c89e4eSSatish Balay 
9366f013253SBarry Smith       PETSC_LIB_DIR uses the environmental variable if it exists. PETSC_ARCH and PETSC_DIR use what
937acc6cc86SBarry Smith       PETSc was built with and do not use environmental variables.
938acc6cc86SBarry Smith 
9396f013253SBarry Smith       Not for use in Fortran
9406f013253SBarry Smith 
941e5c89e4eSSatish Balay    Level: intermediate
942e5c89e4eSSatish Balay 
943e5c89e4eSSatish Balay @*/
9447087cfbeSBarry Smith PetscErrorCode  PetscStrreplace(MPI_Comm comm,const char aa[],char b[],size_t len)
945e5c89e4eSSatish Balay {
946e5c89e4eSSatish Balay   PetscErrorCode ierr;
947e5c89e4eSSatish Balay   int            i = 0;
948e5c89e4eSSatish Balay   size_t         l,l1,l2,l3;
94971573d7dSBarry Smith   char           *work,*par,*epar,env[1024],*tfree,*a = (char*)aa;
950d5649816SBarry Smith   const char     *s[] = {"${PETSC_ARCH}","${PETSC_DIR}","${PETSC_LIB_DIR}","${DISPLAY}","${HOMEDIRECTORY}","${WORKINGDIRECTORY}","${USERNAME}","${HOSTNAME}",0};
951d5649816SBarry Smith   const char     *r[] = {0,0,0,0,0,0,0,0,0};
952ace3abfcSBarry Smith   PetscBool      flag;
953e5c89e4eSSatish Balay 
954e5c89e4eSSatish Balay   PetscFunctionBegin;
955e32f2f54SBarry Smith   if (!a || !b) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"a and b strings must be nonnull");
95671573d7dSBarry Smith   if (aa == b) {
95722982a5fSBarry Smith     ierr    = PetscStrallocpy(aa,(char **)&a);CHKERRQ(ierr);
95871573d7dSBarry Smith   }
959e5c89e4eSSatish Balay   ierr = PetscMalloc(len*sizeof(char*),&work);CHKERRQ(ierr);
960e5c89e4eSSatish Balay 
961e5c89e4eSSatish Balay   /* get values for replaced variables */
962487e5849SBarry Smith   ierr = PetscStrallocpy(PETSC_ARCH,(char**)&r[0]);CHKERRQ(ierr);
963487e5849SBarry Smith   ierr = PetscStrallocpy(PETSC_DIR,(char**)&r[1]);CHKERRQ(ierr);
964487e5849SBarry Smith   ierr = PetscStrallocpy(PETSC_LIB_DIR,(char**)&r[2]);CHKERRQ(ierr);
965487e5849SBarry Smith   ierr = PetscMalloc(256*sizeof(char),&r[3]);CHKERRQ(ierr);
966487e5849SBarry Smith   ierr = PetscMalloc(PETSC_MAX_PATH_LEN*sizeof(char),&r[4]);CHKERRQ(ierr);
967e5c89e4eSSatish Balay   ierr = PetscMalloc(PETSC_MAX_PATH_LEN*sizeof(char),&r[5]);CHKERRQ(ierr);
968487e5849SBarry Smith   ierr = PetscMalloc(256*sizeof(char),&r[6]);CHKERRQ(ierr);
969d5649816SBarry Smith   ierr = PetscMalloc(256*sizeof(char),&r[7]);CHKERRQ(ierr);
970487e5849SBarry Smith   ierr = PetscGetDisplay((char*)r[3],256);CHKERRQ(ierr);
971487e5849SBarry Smith   ierr = PetscGetHomeDirectory((char*)r[4],PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
972487e5849SBarry Smith   ierr = PetscGetWorkingDirectory((char*)r[5],PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
973487e5849SBarry Smith   ierr = PetscGetUserName((char*)r[6],256);CHKERRQ(ierr);
974d5649816SBarry Smith   ierr = PetscGetHostName((char*)r[7],256);CHKERRQ(ierr);
975487e5849SBarry Smith 
976487e5849SBarry Smith   /* replace that are in environment */
977487e5849SBarry Smith   ierr = PetscOptionsGetenv(comm,"PETSC_LIB_DIR",env,1024,&flag);CHKERRQ(ierr);
978487e5849SBarry Smith   if (flag) {
979487e5849SBarry Smith     ierr = PetscStrallocpy(env,(char**)&r[2]);CHKERRQ(ierr);
980487e5849SBarry Smith   }
981e5c89e4eSSatish Balay 
982e5c89e4eSSatish Balay   /* replace the requested strings */
983e5c89e4eSSatish Balay   ierr = PetscStrncpy(b,a,len);CHKERRQ(ierr);
984e5c89e4eSSatish Balay   while (s[i]) {
985e5c89e4eSSatish Balay     ierr = PetscStrlen(s[i],&l);CHKERRQ(ierr);
986e5c89e4eSSatish Balay     ierr = PetscStrstr(b,s[i],&par);CHKERRQ(ierr);
987e5c89e4eSSatish Balay     while (par) {
988e5c89e4eSSatish Balay       *par  =  0;
989e5c89e4eSSatish Balay       par  += l;
990e5c89e4eSSatish Balay 
991e5c89e4eSSatish Balay       ierr = PetscStrlen(b,&l1);CHKERRQ(ierr);
992e5c89e4eSSatish Balay       ierr = PetscStrlen(r[i],&l2);CHKERRQ(ierr);
993e5c89e4eSSatish Balay       ierr = PetscStrlen(par,&l3);CHKERRQ(ierr);
99417186662SBarry Smith       if (l1 + l2 + l3 >= len) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"b len is not long enough to hold new values");
995e5c89e4eSSatish Balay       ierr  = PetscStrcpy(work,b);CHKERRQ(ierr);
996e5c89e4eSSatish Balay       ierr  = PetscStrcat(work,r[i]);CHKERRQ(ierr);
997e5c89e4eSSatish Balay       ierr  = PetscStrcat(work,par);CHKERRQ(ierr);
998e5c89e4eSSatish Balay       ierr  = PetscStrncpy(b,work,len);CHKERRQ(ierr);
999e5c89e4eSSatish Balay       ierr  = PetscStrstr(b,s[i],&par);CHKERRQ(ierr);
1000e5c89e4eSSatish Balay     }
1001e5c89e4eSSatish Balay     i++;
1002e5c89e4eSSatish Balay   }
1003487e5849SBarry Smith   i = 0;
1004487e5849SBarry Smith   while (r[i]) {
1005e5c89e4eSSatish Balay     tfree = (char*)r[i];
1006e5c89e4eSSatish Balay     ierr = PetscFree(tfree);CHKERRQ(ierr);
1007487e5849SBarry Smith     i++;
1008e5c89e4eSSatish Balay   }
1009e5c89e4eSSatish Balay 
1010e5c89e4eSSatish Balay   /* look for any other ${xxx} strings to replace from environmental variables */
1011e5c89e4eSSatish Balay   ierr = PetscStrstr(b,"${",&par);CHKERRQ(ierr);
1012e5c89e4eSSatish Balay   while (par) {
1013e5c89e4eSSatish Balay     *par = 0;
1014e5c89e4eSSatish Balay     par += 2;
1015e5c89e4eSSatish Balay     ierr  = PetscStrcpy(work,b);CHKERRQ(ierr);
1016e5c89e4eSSatish Balay     ierr = PetscStrstr(par,"}",&epar);CHKERRQ(ierr);
1017e5c89e4eSSatish Balay     *epar = 0;
1018e5c89e4eSSatish Balay     epar += 1;
1019e5c89e4eSSatish Balay     ierr = PetscOptionsGetenv(comm,par,env,256,&flag);CHKERRQ(ierr);
10207ba3a57cSBarry Smith     if (!flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Substitution string ${%s} not found as environmental variable",par);
1021e5c89e4eSSatish Balay     ierr = PetscStrcat(work,env);CHKERRQ(ierr);
1022e5c89e4eSSatish Balay     ierr = PetscStrcat(work,epar);CHKERRQ(ierr);
1023e5c89e4eSSatish Balay     ierr = PetscStrcpy(b,work);CHKERRQ(ierr);
1024e5c89e4eSSatish Balay     ierr = PetscStrstr(b,"${",&par);CHKERRQ(ierr);
1025e5c89e4eSSatish Balay   }
1026e5c89e4eSSatish Balay   ierr = PetscFree(work);CHKERRQ(ierr);
102771573d7dSBarry Smith   if (aa == b) {
102871573d7dSBarry Smith     ierr = PetscFree(a);CHKERRQ(ierr);
102971573d7dSBarry Smith   }
1030e5c89e4eSSatish Balay   PetscFunctionReturn(0);
1031e5c89e4eSSatish Balay }
1032e5c89e4eSSatish Balay 
1033e5c89e4eSSatish Balay 
1034