@@ -27,6 +27,12 @@ Module: Read Goto Programs
27
27
#include " elf_reader.h"
28
28
#include " osx_fat_reader.h"
29
29
30
+ // / \brief Read a goto binary from a file, but do not update \ref config
31
+ // / \param filename the file name of the goto binary
32
+ // / \param dest the goto model returned
33
+ // / \param message_handler for diagnostics
34
+ // / \deprecated Use read_goto_binary(file, message_handler) instead
35
+ // / \return true on failure, false on success
30
36
bool read_goto_binary (
31
37
const std::string &filename,
32
38
goto_modelt &dest,
@@ -36,6 +42,10 @@ bool read_goto_binary(
36
42
filename, dest.symbol_table , dest.goto_functions , message_handler);
37
43
}
38
44
45
+ // / \brief Read a goto binary from a file, but do not update \ref config
46
+ // / \param filename the file name of the goto binary
47
+ // / \param message_handler for diagnostics
48
+ // / \return goto model on success, {} on failure
39
49
optionalt<goto_modelt>
40
50
read_goto_binary (const std::string &filename, message_handlert &message_handler)
41
51
{
@@ -50,6 +60,12 @@ read_goto_binary(const std::string &filename, message_handlert &message_handler)
50
60
return std::move (dest);
51
61
}
52
62
63
+ // / \brief Read a goto binary from a file, but do not update \ref config
64
+ // / \param filename the file name of the goto binary
65
+ // / \param symbol_table the symbol table from the goto binary
66
+ // / \param goto_functions the goto functions from the goto binary
67
+ // / \param message_handler for diagnostics
68
+ // / \return true on failure, false on success
53
69
bool read_goto_binary (
54
70
const std::string &filename,
55
71
symbol_tablet &symbol_table,
@@ -206,8 +222,10 @@ bool is_goto_binary(const std::string &filename)
206
222
return false ;
207
223
}
208
224
209
- // / reads an object file
210
- // / \par parameters: a file_name
225
+ // / \brief reads an object file, and also updates config
226
+ // / \param file_name file name of the goto binary
227
+ // / \param dest the goto model returned
228
+ // / \param message_handler for diagnostics
211
229
// / \return true on error, false otherwise
212
230
bool read_object_and_link (
213
231
const std::string &file_name,
@@ -241,8 +259,9 @@ bool read_object_and_link(
241
259
return false ;
242
260
}
243
261
244
- // / reads an object file
245
- // / \par parameters: a file_name
262
+ // / \brief reads an object file, and also updates the config
263
+ // / \param file_name file name of the goto binary
264
+ // / \param message_handler for diagnostics
246
265
// / \return true on error, false otherwise
247
266
bool read_object_and_link (
248
267
const std::string &file_name,
0 commit comments