srecord 1.65.0
 
Loading...
Searching...
No Matches
idt.h
Go to the documentation of this file.
1//
2// srecord - Manipulate EPROM load files
3// Copyright (C) 2011, 2013 Peter Miller
4//
5// This program is free software; you can redistribute it and/or modify it
6// under the terms of the GNU Lesser General Public License as published by
7// the Free Software Foundation; either version 3 of the License, or (at your
8// option) any later version.
9//
10// This program is distributed in the hope that it will be useful, but WITHOUT
11// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13// more details.
14//
15// You should have received a copy of the GNU Lesser General Public License
16// along with this program. If not, see <http://www.gnu.org/licenses/>.
17//
18
19#ifndef SRECORD_INPUT_FILE_IDT_H
20#define SRECORD_INPUT_FILE_IDT_H
21
22#include <srecord/input/file.h>
23
24namespace srecord {
25
26/**
27 * The srecord::input_file_idt class is used to represent the parse
28 * state of a IDT/sim binary format input file.
29 */
30class input_file_idt:
31 public input_file
32{
33public:
34 /**
35 * The destructor.
36 */
37 virtual ~input_file_idt();
38
39 /**
40 * The create class method is used to create new dynamically
41 * allocated instances of this class.
42 *
43 * @param file_name
44 * The name of the file to be read.
45 * @returns
46 * smart pointer to new instance
47 */
48 static pointer create(const std::string &file_name);
49
50protected:
51 // See base class for documentation.
53
54 // See base class for documentation.
55 const char *get_file_format_name(void) const;
56
57 // See base class for documentation.
58 bool is_binary(void) const;
59
60 // See base class for documentation.
61 int format_option_number(void) const;
62
63private:
64 /**
65 * The constructor.
66 *
67 * @param file_name
68 * The name of the file to be read.
69 */
70 input_file_idt(const std::string &file_name);
71
72 /**
73 * The data_count instance variable is used to remember the number
74 * of data lines has occurred fo far in the input file.
75 */
76 unsigned long data_count;
77
78 /**
79 * The read_inner method is used to read a record of input.
80 * The read method is a wrapper around this method.
81 */
82 bool read_inner(record &);
83
84 /**
85 * The seen_some_input instance variable is used to remember where
86 * any data has been seen in this file yet.
87 */
88 bool seen_some_input;
89
90 /**
91 * The record_format_error is a wrapper around #fatal_error to
92 * complain abut format errors.
93 */
94 void record_format_error(void);
95
96 /**
97 * The default constructor. Do not use.
98 */
99 input_file_idt();
100
101 /**
102 * The copy constructor. Do not use.
103 */
104 input_file_idt(const input_file_idt &);
105
106 /**
107 * The assignment operator. Do not use.
108 */
109 input_file_idt &operator=(const input_file_idt &);
110};
111
112};
113
114// vim: set ts=8 sw=4 et :
115#endif // SRECORD_INPUT_FILE_IDT_H
bool is_binary(void) const
The is_binary method is used to to determine whether or not a file format is binary (true) of text (f...
static pointer create(const std::string &file_name)
The create class method is used to create new dynamically allocated instances of this class.
const char * get_file_format_name(void) const
The get_file_format_name method is used to find out the name of the file format being read.
bool read(record &record)
The read method is used to read one record from the input.
int format_option_number(void) const
The format_option_number method is used to obtain the option number, which can then be turned into te...
virtual ~input_file_idt()
The destructor.
input_file(const std::string &file_name)
The constructor.
std::shared_ptr< input_file > pointer
Definition file.h:39
The srecord::record class is used to represent a data record read from a file.
Definition record.h:35