srecord: input/file/mos_tech.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
mos_tech.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 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_MOS_TECH_H
20#define SRECORD_INPUT_FILE_MOS_TECH_H
21
22#include <srecord/input/file.h>
23
24namespace srecord {
25
26/**
27 * The mos_tech class is used to parse a MOS Technology format file.
28 */
29 class input_file_mos_tech:
30 public input_file
31{
32public:
33 /**
34 * The destructor.
35 */
36 virtual ~input_file_mos_tech();
37
38 /**
39 * The create class method is used to create new dynamically
40 * allocated instances of this class.
41 *
42 * @param file_name
43 * The name of the file to be read.
44 * @returns
45 * smart pointer to new instance
46 */
47 static pointer create(const std::string &file_name);
48
49protected:
50 // See base class for documentation.
51 bool read(record &record);
52
53 // See base class for documentation.
54 const char *get_file_format_name(void) const;
55
56 // See base class for documentation.
57 int format_option_number(void) const;
58
59private:
60 /**
61 * A constructor. The input is read from the named file (or
62 * the standard input if the file anme is "-").
63 *
64 * @param file_name
65 * The name of the file to be read.
66 */
67 input_file_mos_tech(const std::string &file_name);
68
69 /**
70 * Read one line (record) of input. Called by the #read method.
71 * Returns false at end of file.
72 */
73 bool read_inner(record &);
74
75 /**
76 * The garbage_warning instance variable is used to remember
77 * whther or not a warning has been issued about non-format
78 * lines in the file. Only one warning per file is issued.
79 */
80 bool garbage_warning;
81
82 /**
83 * The seen_some_input instance variable is used to
84 * remember whether any input has been seen.
85 */
86 bool seen_some_input;
87
88 /**
89 * The data_record_count instance variable is used to remember the
90 * number of data records seen to date.
91 */
92 int data_record_count;
93
94 /**
95 * The default constructor. Do not use.
96 */
97 input_file_mos_tech();
98
99 /**
100 * The copy constructor. Do not use.
101 */
102 input_file_mos_tech(const input_file_mos_tech &);
103
104 /**
105 * The assignment operator. Do not use.
106 */
107 input_file_mos_tech &operator=(const input_file_mos_tech &);
108};
109
110};
111
112#endif // SRECORD_INPUT_FILE_MOS_TECH_H
113// vim: set ts=8 sw=4 et :
srecord::input_file_mos_tech::read
bool read(record &record)
The read method is used to read one record from the input.
srecord::input_file_mos_tech::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_mos_tech::~input_file_mos_tech
virtual ~input_file_mos_tech()
The destructor.
srecord::input_file_mos_tech::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_mos_tech::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::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