include/open_flags.h


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

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2000 Silicon Graphics, Inc.
 * All Rights Reserved.
 */
#ifndef _OPEN_FLAGS_H_
#define _OPEN_FLAGS_H_

/***********************************************************************
 * This function attempts to convert open flag bits into human readable
 * symbols (i.e. O_TRUNC).  If there are more than one symbol,
 * the <sep> string will be placed as a separator between symbols.
 * Commonly used separators would be a comma "," or pipe "|".
 * If <mode> is one and not all <openflags> bits can be converted to
 * symbols, the "UNKNOWN" symbol will be added to return string.
 * 
 * Return Value
 * openflags2symbols will return the indentified symbols.
 * If no symbols are recognized the return value will be a empty
 * string or the "UNKNOWN" symbol.
 *
 * Limitations
 * Currently (05/96) all known symbols are coded into openflags2symbols.
 * If new open flags are added this code will have to updated
 * to know about them or they will not be recognized.
 *
 * The Open_symbols must be large enough to hold all possible symbols
 * for a given system.
 *
 ***********************************************************************/
char *openflags2symbols( int, char *, int );

/***********************************************************************
 * This function will take a string of comma separated open flags symbols
 * and translate them into an open flag bitmask.
 * If any symbol is not valid, -1 is returned.  On this error condition
 * the badname pointer is updated if not NULL.  badname will point
 * to the beginning location of where the invalid symbol was found.
 * string will be returned unchanged. 
 *
 * A signal received while parsing string could cause the string to
 * contain a NULL character in the middle of it.
 *
 ***********************************************************************/
int parse_open_flags( char *, char ** );

#endif