srecord 1.65.0
 
Loading...
Searching...
No Matches
signetics.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 2001-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_SIGNETICS_H
20#define SRECORD_INPUT_FILE_SIGNETICS_H
21
22#include <srecord/input/file.h>
23
24namespace srecord {
25
26/**
27 * The srecord::input_file_signetics class is used to represent reading a
28 * Signetics format file.
29 */
30class input_file_signetics:
31 public input_file
32{
33public:
34 /**
35 * The destructor.
36 */
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 int format_option_number(void) const;
59
60 /**
61 * See base class for documentation. We over-ride this method
62 * because signetics uses its own XOR-ROL checksum algorithm.
63 */
64 void checksum_add(unsigned char);
65
66private:
67 /**
68 * The constructor. The input will be read from the named file
69 * (or the standatd input if the filename is "-").
70 *
71 * @param file_name
72 * The name of the file to be read.
73 */
74 input_file_signetics(const std::string &file_name);
75
76 /**
77 * The default constructor. Do not use.
78 */
79 input_file_signetics();
80
81 /**
82 * The copy constructor. Do not use.
83 */
84 input_file_signetics(const input_file_signetics &);
85
86 /**
87 * The assignment operator. Do not use.
88 */
89 input_file_signetics &operator=(const input_file_signetics &);
90
91 /**
92 * The read_inner method is used to read one line/record from
93 * the input. Used by the `read' method.
94 */
95 bool read_inner(record &);
96
97 /**
98 * The garbage_warning instance variable is used to remember
99 * whther or not a warning has been issued about non-format
100 * lines in the file. Only one warning per file is issued.
101 */
102 bool garbage_warning;
103
104 /**
105 * The seen_some_input instance variable is used to
106 * remember whether any input has been seen.
107 */
108 bool seen_some_input;
109};
110
111};
112
113#endif // SRECORD_INPUT_FILE_SIGNETICS_H
114// vim: set ts=8 sw=4 et :
virtual ~input_file_signetics()
The destructor.
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...
bool read(record &record)
The read method is used to read one record from the input.
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.
void checksum_add(unsigned char)
See base class for documentation.
static pointer create(const std::string &file_name)
The create class method is used to create new dynamically allocated instances of this class.
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