src/common/print_fields.h

/*****************************************************************************\
 *  printfields.h - definitions for all printing functions.
 *****************************************************************************
 *  Copyright (C) 2008 Lawrence Livermore National Security.
 *  Copyright (C) 2002-2007 The Regents of the University of California.
 *  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
 *  Written by Danny Auble <da@llnl.gov>
 *  CODE-OCEC-09-009. All rights reserved.
 *
 *  This file is part of Slurm, a resource management program.
 *  For details, see <https://slurm.schedmd.com/>.
 *  Please also read the included file: DISCLAIMER.
 *
 *  Slurm is free software; you can redistribute it and/or modify it under
 *  the terms of the GNU General Public License as published by the Free
 *  Software Foundation; either version 2 of the License, or (at your option)
 *  any later version.
 *
 *  In addition, as a special exception, the copyright holders give permission
 *  to link the code of portions of this program with the OpenSSL library under
 *  certain conditions as described in each individual source file, and
 *  distribute linked combinations including the two. You must obey the GNU
 *  General Public License in all respects for all of the code used other than
 *  OpenSSL. If you modify file(s) with this exception, you may extend this
 *  exception to your version of the file(s), but you are not obligated to do
 *  so. If you do not wish to do so, delete this exception statement from your
 *  version.  If you delete this exception statement from all source files in
 *  the program, then also delete it here.
 *
 *  Slurm is distributed in the hope that it will be useful, but WITHOUT ANY
 *  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 *  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 *  details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with Slurm; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA.
\*****************************************************************************/
#ifndef __PRINT_FIELDS_H__
#define __PRINT_FIELDS_H__

#include <ctype.h>
#include <errno.h>
#include <getopt.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>

#include "slurm/slurm.h"

#include "src/common/xmalloc.h"
#include "src/common/xstring.h"
#include "src/common/list.h"

typedef struct print_field print_field_t;

struct print_field {
	int len;  /* what is the width of the print */
	char *name;  /* name to be printed in header */
	/* what is the function to print with  */
	void (*print_routine) (print_field_t *field, void *value, int last);
	uint16_t type; /* defined in the local function */
};

typedef struct {
	uint32_t array_job_id;
	uint32_t array_task_id;
	char *first_step_node;
	bool is_srun;
	bool io_per_task;
	char *jobname;
	uint32_t nodeid;
	uint16_t restart_cnt;
	slurm_step_id_t step_id;
	uint32_t taskid;
	char *user;
	char *work_dir;
} job_std_pattern_t;

enum {
	PRINT_FIELDS_PARSABLE_NOT = 0,
	PRINT_FIELDS_PARSABLE_ENDING,
	PRINT_FIELDS_PARSABLE_NO_ENDING
};

extern int print_fields_parsable_print;
extern int print_fields_have_header;
extern char *fields_delimiter;

extern void destroy_print_field(void *object);
extern void print_fields_header(list_t *print_fields_list);
extern void print_fields_date(print_field_t *field, void *input, int last);
extern void print_fields_str(print_field_t *field, void *input, int last);
extern void print_fields_double(print_field_t *field, void *input, int last);
/* print_fields_t->print_routine does not like uint16_t being passed
 * in so pass in a uint32_t and typecast.
 */
extern void print_fields_uint16(print_field_t *field, void *input, int last);
extern void print_fields_uint32(print_field_t *field, void *input, int last);
extern void print_fields_uint64(print_field_t *field, void *input, int last);
extern void print_fields_time_from_mins(print_field_t *field,
					void *input, int last);
extern void print_fields_time_from_secs(print_field_t *field,
					void *input, int last);
extern void print_fields_sluid(print_field_t *field, void *input, int last);
extern void print_fields_char_list(print_field_t *field, void *input, int last);
extern char *expand_stdio_fields(char *stdio_path, job_std_pattern_t *job);

#define print_fields_uint print_fields_uint32
#define print_fields_time print_fields_time_from_mins
#endif