/usr/include/srecord/output.h is in libsrecord-dev 1.56-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 | //
// srecord - manipulate eprom load files
// Copyright (C) 1998, 1999, 2001-2003, 2006-2010 Peter Miller
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation; either version 3 of the License, or (at your
// option) any later version.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
// for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
#ifndef SRECORD_OUTPUT_H
#define SRECORD_OUTPUT_H
#include <cstdarg>
#include <string>
#include <boost/shared_ptr.hpp>
#include <srecord/format_printf.h>
namespace srecord {
class arglex_tool; // forward
class record; // forward
/**
* The srecord::output class is used to represent an abstract output vector.
* It could be a file, it could be a filter first, before it reaches
* a file.
*/
class output
{
public:
typedef boost::shared_ptr<output> pointer;
/**
* The destructor.
*/
virtual ~output();
/**
* The write method is used to write a recordonto an output.
* Derived classes must implement this method.
*/
virtual void write(const record &) = 0;
/**
* The write_header method is used to write a header record
* to the output. If no record is specified, a default
* record will be supplied. The write method will be called.
*/
virtual void write_header(const record * = 0);
/**
* The write_data method is used to write data to the output.
* A suitable data record wil be produced. The write method
* will be called.
*/
virtual void write_data(unsigned long, const void *, size_t);
/**
* The write_execution_start_address method is used to write an
* execution start address record to the output. If no record is
* specified, a default record will be supplied. The write method
* will be called.
*/
virtual void write_execution_start_address(const record * = 0);
/**
* The set_line_length method is used to set the maximum
* length of an output line, for those formats for which
* this is a meaningful concept, and the line length is at
* all controllable. Derived classes must implement this method.
*/
virtual void line_length_set(int) = 0;
/**
* The address_length_set method is used to set the minimum
* number of bytes to be written for addresses in the output,
* for those formats for which this is a meaningful concept, and
* the address length is at all controllable. Derived classes
* must implement this method.
*/
virtual void address_length_set(int) = 0;
/**
* The preferred_block_size_get method is used to get the
* proferred block size of the output fformat. Often, but not
* always, influenced by the line_lebgth_set method. Derived
* classes must implement this method.
*/
virtual int preferred_block_size_get() const = 0;
/**
* The preferred_block_size_set method is is to set a precific
* number of bytes for the preferred block size.
*
* @param nbytes
* The exact number of bytes to be returned by the
* #preferred_block_size_get method.
* @returns
* There are format-specific limitations on block sizes, this
* method will return true if the setting was acceptable, false
* if the format is incapable of using the specified block
* size.
*/
virtual bool preferred_block_size_set(int nbytes) = 0;
/**
* The fatal_error method is used to report fatal errors.
* The `fmt' string is in the same style a standard C printf
* function. It calls the fatal_error_v method. This method
* does not return.
*/
virtual void fatal_error(const char *fmt, ...) const
FORMAT_PRINTF(2, 3);
/**
* The fatal_error_v method is used to report fatal errors.
* The `fmt' string is in the same style a standard C vprintf
* function. It calls ::exit. This method does not return.
*/
virtual void fatal_error_v(const char *fmt, va_list ap) const;
/**
* The fatal_error_errno method is used to report fatal errors,
* and append the string equivalent of errno. The `fmt' string
* is in the same style a standard C printf function. It calls
* ::exit(). This method does not return.
*/
virtual void fatal_error_errno(const char *fmt, ...) const
FORMAT_PRINTF(2, 3);
/**
* The fatal_error_errno_v method is used to report fatal
* errors. The `fmt' string is in the same style a standard C
* vprintf function. It calls the ::exit function.
* This method does not return.
*/
virtual void fatal_error_errno_v(const char *fmt, va_list ap) const;
/**
* The warning method is used to likely but non-fatal errors.
* The `fmt' string is in the same style a standard C printf
* function. It calls the warning_v method.
*/
virtual void warning(const char *fmt, ...) const
FORMAT_PRINTF(2, 3);
/**
* The warning_v method is used to report likely but non-fatal
* errors. The `fmt' string is in the same style a standard
* C vprintf function.
*/
virtual void warning_v(const char *fmt, va_list ap) const;
/**
* The filename method is used to determine the name of the
* output file. It is used for the various error messages.
* Derived classes must implement this method.
*/
virtual const std::string filename() const = 0;
/**
* The format_name method is used to obtain the name of this output
* format.
*/
virtual const char *format_name() const = 0;
/**
* The notify_upper_bound method is used to notify the output class
* of the upper bound (highest address plus one) of the output
* to come. Shall be called before the head or any data records
* are written.
*
* @param addr
* One past the highest used memory byte.
*/
virtual void notify_upper_bound(unsigned long addr);
/**
* The command_line method is used by arglex_srec::get_output when
* parsing the command line, to give the format an opportunity
* to grab extra arguments off the command line. The default
* implementation does nothing.
*
* @param cmdln
* Where to obtain information about the curreent parse stat of
* the command line.
*/
virtual void command_line(arglex_tool *cmdln);
protected:
/**
* The default constructor. Only derived classes may use.
*/
output();
private:
/**
* The copy constructor. Do not use.
*/
output(const output &);
/**
* The assignment operator. Do not use.
*/
output &operator=(const output &);
};
};
#endif // SRECORD_OUTPUT_H
|