kicad-source/pcbnew/router/pns_logger.h
Tomasz Wlostowski 379aa8f3b5 router: clearer distinction between LOGGER and DEBUG_DECORATOR classes.
The first one keeps a log of events (start routing, mouse motion, etc).
The second allows for adding temporary debug drawings and messages which are stored synchronously with the events in LOGGER.

The event stream together with the PCB design (now with UUIDs) can be used to deterministically replay routing bugs as the user sees them.
2020-07-22 18:05:54 +02:00

76 lines
1.6 KiB
C++

/*
* KiRouter - a push-and-(sometimes-)shove PCB router
*
* Copyright (C) 2013-2014 CERN
* Copyright (C) 2016 KiCad Developers, see AUTHORS.txt for contributors.
* Author: Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU 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
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __PNS_LOGGER_H
#define __PNS_LOGGER_H
#include <cstdio>
#include <vector>
#include <string>
#include <sstream>
#include <math/vector2d.h>
class SHAPE_LINE_CHAIN;
class SHAPE;
namespace PNS {
class ITEM;
class LOGGER
{
public:
enum EVENT_TYPE {
EVT_START_ROUTE = 0,
EVT_START_DRAG,
EVT_FIX,
EVT_MOVE,
EVT_ABORT
};
struct EVENT_ENTRY {
VECTOR2I p;
EVENT_TYPE type;
const ITEM* item;
};
LOGGER();
~LOGGER();
void Save( const std::string& aFilename );
void Clear();
void Log( EVENT_TYPE evt, VECTOR2I pos, const ITEM* item = nullptr );
const std::vector<EVENT_ENTRY>& GetEvents()
{
return m_events;
}
private:
std::vector<EVENT_ENTRY> m_events;
};
}
#endif