srecord: input/file/cosmac.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
cosmac.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 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_COSMAC_H
20#define SRECORD_INPUT_FILE_COSMAC_H
21
22#include <srecord/input/file.h>
23
24namespace srecord {
25
26/**
27 * The srecord::input_file_cosmac class is used to represent the parse
28 * state when reading an RCS Cosmac formatted file.
29 */
30 class input_file_cosmac:
31 public input_file
32{
33public:
34 /**
35 * The destructor.
36 */
37 virtual ~input_file_cosmac();
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_cosmac(const std::string &file_name);
68
69 /**
70 * The state instance variable is used to remember where we are in
71 * parsing the !M command.
72 *
73 * \n no command seen yet
74 * ! have seen the ! character
75 * M have seen the !M characters, want an address
76 * sp have seen !Maaaa, want data bytes
77 * , have seen , charcter, discarding to \n, then resume sp state
78 * ; have seen , charcter, discarding to \n, then resume M state
79 */
80 char state;
81
82 /**
83 * The address instance variable is used to remember what address
84 * we are up to in the input.
85 */
86 unsigned long address;
87
88 /**
89 * The seen_some_input instance variable is used to remember whether
90 * the file has any contents or not.
91 */
92 bool seen_some_input;
93
94 /**
95 * The default constructor. Do not use.
96 */
97 input_file_cosmac();
98
99 /**
100 * The copy constructor. Do not use.
101 */
102 input_file_cosmac(const input_file_cosmac &);
103
104 /**
105 * The assignment operator. Do not use.
106 */
107 input_file_cosmac &operator=(const input_file_cosmac &);
108};
109
110};
111
112#endif // SRECORD_INPUT_FILE_COSMAC_H
113// vim: set ts=8 sw=4 et :
srecord::input_file_cosmac::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_cosmac::read
bool read(record &record)
The read method is used to read one record from the input.
srecord::input_file_cosmac::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_cosmac::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_cosmac::~input_file_cosmac
virtual ~input_file_cosmac()
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