RNAlib-2.4.5
commands.h
Go to the documentation of this file.
1 #ifndef VIENNA_RNA_PACKAGE_COMMANDS_H
2 #define VIENNA_RNA_PACKAGE_COMMANDS_H
3 
17 typedef struct vrna_command_s vrna_cmd_t;
18 
19 
21 
26 #define VRNA_CMD_PARSE_HC 1U
27 
31 #define VRNA_CMD_PARSE_SC 2U
32 
36 #define VRNA_CMD_PARSE_UD 4U
37 
41 #define VRNA_CMD_PARSE_SD 8U
42 
46 #define VRNA_CMD_PARSE_DEFAULTS (VRNA_CMD_PARSE_HC \
47  | VRNA_CMD_PARSE_SC \
48  | VRNA_CMD_PARSE_UD \
49  | VRNA_CMD_PARSE_SD \
50  )
51 
52 #define VRNA_CMD_PARSE_SILENT 16U
53 
57 typedef enum {
58  VRNA_CMD_ERROR = -1,
59  VRNA_CMD_LAST = 0,
60  VRNA_CMD_HC,
61  VRNA_CMD_SC,
62  VRNA_CMD_MOTIF,
63  VRNA_CMD_UD,
64  VRNA_CMD_SD
66 
72  vrna_command_e type;
73  void *data;
74 };
75 
89 vrna_cmd_t *vrna_file_commands_read(const char *filename,
90  unsigned int options);
91 
92 
107  const char *filename,
108  unsigned int options);
109 
110 
120  vrna_cmd_t *commands,
121  unsigned int options);
122 
123 
130 void vrna_commands_free(vrna_cmd_t *commands);
131 
132 
137 #endif
void vrna_commands_free(vrna_cmd_t *commands)
Free memory occupied by a list of commands.
The most basic data structure required by many functions throughout the RNAlib.
Definition: fold_compound.h:131
vrna_cmd_t * vrna_file_commands_read(const char *filename, unsigned int options)
Extract a list of commands from a command file.
Various data structures and pre-processor macros.
int vrna_file_commands_apply(vrna_fold_compound_t *vc, const char *filename, unsigned int options)
Apply a list of commands from a command file.
vrna_command_e
Types of commands within a list of vrna_command_s structures.
Definition: commands.h:57
int vrna_commands_apply(vrna_fold_compound_t *vc, vrna_cmd_t *commands, unsigned int options)
Apply a list of commands to a vrna_fold_compound_t.
List element for commands ready for application to a vrna_fold_compound_t.
Definition: commands.h:71