xorriso  1.5.4.pl02
About: GNU xorriso creates, loads, manipulates and writes ISO 9660 filesystem images with Rock Ridge extensions. It is suitable for incremental data backup and for production of bootable ISO 9660 images. GNU xorriso is a statical compilation of the libraries libburn, libisofs, libisoburn, and libjte.
  Fossies Dox: xorriso-1.5.4.pl02.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

text_io.h
Go to the documentation of this file.
1 
2 /* xorriso - creates, loads, manipulates and burns ISO 9660 filesystem images.
3 
4  Copyright 2007-2014 Thomas Schmitt, <scdbackup@gmx.net>
5 
6  Provided under GPL version 2 or later.
7 
8  This file contains declarations of text i/o functions.
9 */
10 
11 
12 #ifndef Xorriso_pvt_textio_includeD
13 #define Xorriso_pvt_textio_includeD yes
14 
15 
16 int Xorriso_dialog_input(struct XorrisO *xorriso, char line[], int linesize,
17  int flag);
18 
19 /** @return -1= abort , 0= no , 1= yes
20 */
21 int Xorriso_reassure(struct XorrisO *xorriso, char *cmd, char *which_will,
22  int flag);
23 
24 int Xorriso_request_confirmation(struct XorrisO *xorriso, int flag);
25 
26 /* @param flag bit0= quoted multiline mode
27  bit1= release allocated memory and return 1
28  bit2= with bit0: warn of empty text arguments
29  bit3= deliver as single quoted text including all whitespace
30  and without any backslash interpretation
31  @return -1=out of memory , 0=line format error , 1=ok, go on , 2=done
32 */
33 int Xorriso_read_lines(struct XorrisO *xorriso, FILE *fp, int *linecount,
34  int *argc, char ***argv, int flag);
35 
36 int Xorriso_write_to_channel(struct XorrisO *xorriso,
37  char *in_text, int channel_no, int flag);
38 
39 int Xorriso_result(struct XorrisO *xorriso, int flag);
40 
41 int Xorriso_restxt(struct XorrisO *xorriso, char *text);
42 
43 int Xorriso_info(struct XorrisO *xorriso, int flag);
44 
45 int Xorriso_mark(struct XorrisO *xorriso, int flag);
46 
47 
48 int Xorriso_write_session_log(struct XorrisO *xorriso, int flag);
49 
50 
51 int Xorriso_status_result(struct XorrisO *xorriso, char *filter, FILE *fp,
52  int flag);
53 
54 int Xorriso_status(struct XorrisO *xorriso, char *filter, FILE *fp, int flag);
55 
56 int Xorriso_pacifier_reset(struct XorrisO *xorriso, int flag);
57 
58 /* This call is to be issued by long running workers in short intervals.
59  It will check whether enough time has elapsed since the last pacifier
60  message and eventually issue an update message.
61  @param what_done A sparse description of the action, preferably in past
62  tense. E.g. "done" , "files added".
63  @param count The number of objects processed so far.
64  Is ignored if <=0.
65  @param todo The number of objects to be done in total.
66  Is ignored if <=0.
67  @param current_object A string telling the object currently processed.
68  Ignored if "".
69  @param flag bit0= report unconditionally, no time check
70 */
71 int Xorriso_pacifier_callback(struct XorrisO *xorriso, char *what_done,
72  off_t count, off_t todo, char *current_object,
73  int flag);
74 
75 int Xorriso_reset_counters(struct XorrisO *xorriso, int flag);
76 
77 int Xorriso_no_malloc_memory(struct XorrisO *xorriso, char **to_free,
78  int flag);
79 
80 int Xorriso_much_too_long(struct XorrisO *xorriso, int len, int flag);
81 
82 int Xorriso_no_findjob(struct XorrisO *xorriso, char *cmd, int flag);
83 
84 int Xorriso_report_md5_outcome(struct XorrisO *xorriso, char *severity,
85  int flag);
86 
87 int Xorriso_protect_stdout(struct XorrisO *xorriso, int flag);
88 
89 int Xorriso_msg_op_parse(struct XorrisO *xorriso, char *line,
90  char *prefix, char *separators,
91  int max_words, int pflag, int input_lines,
92  int flag);
93 
94 int Xorriso_msg_op_parse_bulk(struct XorrisO *xorriso,
95  char *prefix, char *separators,
96  int max_words, int pflag, int bulk_lines,
97  int flag);
98 
99 int Xorriso_launch_frontend(struct XorrisO *xorriso, int argc, char **argv,
100  char *cmd_pipe_adr, char *reply_pipe_adr, int flag);
101 
102 int Xorriso_named_pipe_loop(struct XorrisO *xorriso,
103  char *pipe_paths[3], int flag);
104 
105 char *Xorriso_esc_filepath(struct XorrisO *xorriso,
106  char *in_text, char *out_text, int flag);
107 
108 int Xorriso_set_info_text(struct XorrisO *xorriso, char *text,
109  size_t trunc_len, int flag);
110 
111 #ifdef Xorriso_with_editlinE
112 int Xorriso__shutdown_editline(int flag);
113 #endif
114 
115 #ifdef Xorriso_with_readlinE
116 const char *Xorriso__readline_license(int flag);
117 #endif
118 
119 #endif /* ! Xorriso_pvt_textio_includeD */
120 
int Xorriso_reset_counters(struct XorrisO *xorriso, int flag)
Definition: text_io.c:4065
int Xorriso_read_lines(struct XorrisO *xorriso, FILE *fp, int *linecount, int *argc, char ***argv, int flag)
Definition: text_io.c:644
int Xorriso_launch_frontend(struct XorrisO *xorriso, int argc, char **argv, char *cmd_pipe_adr, char *reply_pipe_adr, int flag)
Definition: text_io.c:4303
int Xorriso_no_findjob(struct XorrisO *xorriso, char *cmd, int flag)
Definition: text_io.c:4110
int Xorriso_request_confirmation(struct XorrisO *xorriso, int flag)
Definition: text_io.c:493
int Xorriso_pacifier_callback(struct XorrisO *xorriso, char *what_done, off_t count, off_t todo, char *current_object, int flag)
Definition: text_io.c:3969
int Xorriso_no_malloc_memory(struct XorrisO *xorriso, char **to_free, int flag)
Definition: text_io.c:4077
int Xorriso_write_session_log(struct XorrisO *xorriso, int flag)
Definition: text_io.c:2638
int Xorriso_named_pipe_loop(struct XorrisO *xorriso, char *pipe_paths[3], int flag)
Definition: text_io.c:4551
int Xorriso_info(struct XorrisO *xorriso, int flag)
Definition: text_io.c:2367
int Xorriso_status(struct XorrisO *xorriso, char *filter, FILE *fp, int flag)
Definition: text_io.c:2764
int Xorriso_write_to_channel(struct XorrisO *xorriso, char *in_text, int channel_no, int flag)
Definition: text_io.c:911
int Xorriso_msg_op_parse(struct XorrisO *xorriso, char *line, char *prefix, char *separators, int max_words, int pflag, int input_lines, int flag)
Definition: text_io.c:4161
int Xorriso_protect_stdout(struct XorrisO *xorriso, int flag)
Definition: text_io.c:63
int Xorriso_report_md5_outcome(struct XorrisO *xorriso, char *severity, int flag)
Definition: text_io.c:4118
int Xorriso_msg_op_parse_bulk(struct XorrisO *xorriso, char *prefix, char *separators, int max_words, int pflag, int bulk_lines, int flag)
Definition: text_io.c:4239
char * Xorriso_esc_filepath(struct XorrisO *xorriso, char *in_text, char *out_text, int flag)
Definition: text_io.c:4742
int Xorriso_pacifier_reset(struct XorrisO *xorriso, int flag)
Definition: text_io.c:3937
int Xorriso_set_info_text(struct XorrisO *xorriso, char *text, size_t trunc_len, int flag)
Definition: text_io.c:4768
int Xorriso_reassure(struct XorrisO *xorriso, char *cmd, char *which_will, int flag)
Definition: text_io.c:2609
int Xorriso_much_too_long(struct XorrisO *xorriso, int len, int flag)
Definition: text_io.c:4097
int Xorriso_status_result(struct XorrisO *xorriso, char *filter, FILE *fp, int flag)
Definition: text_io.c:2687
int Xorriso_result(struct XorrisO *xorriso, int flag)
Definition: text_io.c:2337
int Xorriso_mark(struct XorrisO *xorriso, int flag)
Definition: text_io.c:2403
int Xorriso_restxt(struct XorrisO *xorriso, char *text)
Definition: text_io.c:2423
int Xorriso_dialog_input(struct XorrisO *xorriso, char line[], int linesize, int flag)
Definition: text_io.c:316