/usr/include/srecord/memory/walker.h is in libsrecord-dev 1.58-1.
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 | //
// srecord - manipulate eprom load files
// Copyright (C) 1998, 1999, 2002, 2003, 2006-2008, 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_MEMORY_WALKER_H
#define SRECORD_MEMORY_WALKER_H
#include <boost/shared_ptr.hpp>
namespace srecord {
class record; // forward
/**
* The srecord::memory_walker class is used to represent an abstract handler
* for the action to perform when walking a memory image.
*/
class memory_walker
{
public:
typedef boost::shared_ptr<memory_walker> pointer;
/**
* The destructor.
*/
virtual ~memory_walker();
/**
* The observe method is used by the memory walker to provide data.
* Derived classes are required to impliment this method, and do
* something with the data.
*
* @param address
* The base address of this chunk of memory.
* @param data
* The base address of this chunk of memory in memory.
* @param data_size
* The size, in bytes, of this chunk of memory.
*/
virtual void observe(unsigned long address, const void *data,
int data_size) = 0;
/**
* The notify_upper_bound method is used to notify the walker of
* the upper bound (highest address plus one) of the observe calls
* to come. Shall be called before the any observe calls are made.
* By default, nothing happens.
*
* @param address
* The address of the byte immediately beyond the used memory.
*/
virtual void notify_upper_bound(unsigned long address);
/**
* The observe_header method is used to inform the walker of the
* header record. The default does nothing.
*
* @param rec
* The record to be processed.
*/
virtual void observe_header(const record *rec = 0);
/**
* The observe_start_address method is used to inform the walker
* of the execution start address record. The default does nothing.
*
* @param rec
* The record to be processed.
*/
virtual void observe_start_address(const record *rec = 0);
protected:
/**
* The default constructor. May only be called by derived classes.
*/
memory_walker();
private:
/**
* The copy constructor. Do not use.
*/
memory_walker(const memory_walker &);
/**
* The assignment operator. Do not use.
*/
memory_walker &operator=(const memory_walker &);
};
};
#endif // SRECORD_MEMORY_WALKER_H
|