srecord: input/file/intel.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
intel.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 1998-2000, 2002, 2003, 2006-2008, 2010, 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 Lesser General Public
13// License for 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_INTEL_H
20#define SRECORD_INPUT_FILE_INTEL_H
21
22#include <srecord/input/file.h>
23
24namespace srecord {
25
26/**
27 * The srecord::input_file_intel class is used to represent the parse state
28 * of an Intel Hex formatted file.
29 */
30 class input_file_intel:
31 public input_file
32{
33public:
34 /**
35 * The destructor.
36 */
37 virtual ~input_file_intel();
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.
52 bool read(record &record);
53
54 // See base class for documentation.
55 const char *get_file_format_name(void) const;
56
57 // See base class for documentation.
58 int format_option_number(void) const;
59
60private:
61 /**
62 * The constructor.
63 *
64 * @param file_name
65 * The name of the file to be read.
66 */
67 input_file_intel(const std::string &file_name);
68
69 /**
70 * Read one record from the file. The read method is a wrapper
71 * around this method.
72 */
73 bool read_inner(record &);
74
75 /**
76 * The data_record_count instance variable is used to remember the
77 * number of data records seen to date.
78 */
79 int data_record_count;
80
81 /**
82 * The garbage_warning instance variable is used to remember wherther
83 * or not a warning has already been issued about garbage lines
84 * of input.
85 */
86 bool garbage_warning;
87
88 /**
89 * The seen_some_input instance variable is used to remember whether
90 * or not the file contains any data.
91 */
92 bool seen_some_input;
93
94 /**
95 * The termination_seen instance variable is used to remember
96 * whether or not a termination record has been seen yet.
97 */
98 bool termination_seen;
99
100 enum mode_t
101 {
102 mode_linear, // aka i32hex
103 mode_segmented, // aka i16hex
104 mode_i8hex
105 };
106
107 /**
108 * The mode instance variable is used to remember what addressing
109 * mode the file is currently in.
110 */
111 mode_t mode;
112
113 /**
114 * The address_base instance variable is used to remember the
115 * segment base address when in segmented addressing mode.
116 */
117 unsigned long address_base;
118
119 /**
120 * The pushback instance variable is used to remember the previous
121 * record in the file. This is needed in some instances, but not always.
122 */
123 record *pushback;
124
125 /**
126 * The end_seen instance variable is used to remember whether or
127 * not the end of file has been seen yet.
128 */
129 bool end_seen;
130
131 /**
132 * The default constructor. Do not use.
133 */
134 input_file_intel();
135
136 /**
137 * The copy constructor. Do not use.
138 */
139 input_file_intel(const input_file_intel &);
140
141 /**
142 * The assignment operator. Do not use.
143 */
144 input_file_intel &operator=(const input_file_intel &);
145};
146
147};
148
149#endif // SRECORD_INPUT_FILE_INTEL_H
150// vim: set ts=8 sw=4 et :
srecord::input_file_intel
The srecord::input_file_intel class is used to represent the parse state of an Intel Hex formatted fi...
Definition intel.h:32
srecord::input_file_intel::read
bool read(record &record)
The read method is used to read one record from the input.
srecord::input_file_intel::get_file_format_name
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.
srecord::input_file_intel::create
static pointer create(const std::string &file_name)
The create class method is used to create new dynamically allocated instances of this class.
srecord::input_file_intel::format_option_number
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...
srecord::input_file_intel::~input_file_intel
virtual ~input_file_intel()
The destructor.
srecord::input_file::input_file
input_file(const std::string &file_name)
The constructor.
srecord::input_file::pointer
std::shared_ptr< input_file > pointer
Definition file.h:39
srecord::record
The srecord::record class is used to represent a data record read from a file.
Definition record.h:35
file.h
srecord
Definition adler16.h:25