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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
#ifndef __SGE_SPOOLING_UTILITIES_H
#define __SGE_SPOOLING_UTILITIES_H
/*___INFO__MARK_BEGIN__*/
/*************************************************************************
*
* The Contents of this file are made available subject to the terms of
* the Sun Industry Standards Source License Version 1.2
*
* Sun Microsystems Inc., March, 2001
*
*
* Sun Industry Standards Source License Version 1.2
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.2 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://gridengine.sunsource.net/Gridengine_SISSL_license.html
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2001 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
************************************************************************/
/*___INFO__MARK_END__*/
#include "uti/sge_dstring.h"
#include "cull/cull.h"
#include "sgeobj/sge_object.h"
/****** spool/utilities/--Spooling-Utilities************************************
*
* NAME
* Spooling Utilities -- common data structures and functions for spooling
*
* FUNCTION
* The module provides utility functions used for spooling.
*
* SEE ALSO
* spool/utilities/-Spooling-Utilities-Typedefs
* spool/utilities/spool_get_fields_to_spool()
****************************************************************************
*/
/****** spool/utilities/-Spooling-Utilities-Typedefs ***************************
*
* NAME
* Typedefs -- type definitions for spooling utility functions
*
* SYNOPSIS
* typedef struct spool_instr {
* int selection;
* bool copy_field_names;
* bool strip_field_prefix;
* const struct spool_instr *sub_instr;
* } spool_instr;
*
* extern const spool_instr spool_config_instr;
*
* typedef struct spooling_field {
* int nm;
* int width;
* const char *name;
* const struct spooling_field *sub_fields;
* int (*read_func) (lListElem *ep, int nm, const char *buffer, lList **alp);
* int (*write_func) (const lListElem *ep, int nm, dstring *buffer, lList **alp);
* } spooling_field;
*
* FUNCTION
* spooling_instr
* Describes how the fields to be spooled are selected.
* The int field "selection" contains a bitmask that will be applied
* to the mt field of a field descriptor to check, if a field has to be
* spooled.
* sub_instr points to a spool_instr that will be used
* to spool elements in sublists.
*
* spooling_field
* An array of spooling_fields is provides the necessary information
* for the formatted output of data.
* It contains the names and types of attributes to spool, information
* about field width (for formatted output), the attribute name that shall
* be used in output.
* For list fields, that shall be spooled, it contains an array of
* fields that shall be spooled in sublist objects.
*
* NOTES
* May not allow really comprehensive output in all possible variations,
* but it seems to be sufficient for all spooling and output done in
* Grid Engine.
*
* SEE ALSO
* spool/utilities/spool_get_fields_to_spool()
* spool/utilities/spool_free_spooling_fields()
****************************************************************************
*/
typedef struct spool_instr {
int selection;
bool copy_field_names;
bool strip_field_prefix;
const struct spool_instr *sub_instr;
const void *clientdata;
} spool_instr;
extern const spool_instr spool_config_instr;
extern const spool_instr spool_config_subinstr;
extern const spool_instr spool_complex_instr;
extern const spool_instr spool_complex_subinstr;
extern const spool_instr spool_user_instr;
extern const spool_instr spool_userprj_subinstr;
typedef struct spooling_field {
int nm;
int width;
const char *name;
struct spooling_field *sub_fields;
const void *clientdata;
int (*read_func) (lListElem *ep, int nm, const char *buffer, lList **alp);
int (*write_func) (const lListElem *ep, int nm, dstring *buffer, lList **alp);
} spooling_field;
spooling_field *
spool_get_fields_to_spool(lList **answer_list, const lDescr *descr,
const spool_instr *instr);
spooling_field *
spool_free_spooling_fields(spooling_field *fields);
bool
spool_default_validate_func(lList **answer_list,
const lListElem *type,
const lListElem *rule,
lListElem *object,
const sge_object_type object_type);
bool
spool_default_validate_list_func(lList **answer_list,
const lListElem *type, const lListElem *rule,
const sge_object_type object_type);
#endif /* __SGE_SPOOLING_UTILITIES_H */
|
