OpenWalnut
1.2.5
|
00001 //--------------------------------------------------------------------------- 00002 // 00003 // Project: OpenWalnut ( http://www.openwalnut.org ) 00004 // 00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS 00006 // For more information see http://www.openwalnut.org/copying 00007 // 00008 // This file is part of OpenWalnut. 00009 // 00010 // OpenWalnut is free software: you can redistribute it and/or modify 00011 // it under the terms of the GNU Lesser General Public License as published by 00012 // the Free Software Foundation, either version 3 of the License, or 00013 // (at your option) any later version. 00014 // 00015 // OpenWalnut is distributed in the hope that it will be useful, 00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00018 // GNU Lesser General Public License for more details. 00019 // 00020 // You should have received a copy of the GNU Lesser General Public License 00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>. 00022 // 00023 //--------------------------------------------------------------------------- 00024 00025 #ifndef WPROJECTFILEIO_H 00026 #define WPROJECTFILEIO_H 00027 00028 #include <ostream> 00029 #include <string> 00030 00031 #include "WExportCommon.h" 00032 /** 00033 * A base class for all parts of OpenWalnut which can be serialized to a project file. It is used by WProjectFile to actually parse the file line 00034 * by line. Derive from this class if you write your own parser and use it to fill your internal data structures. 00035 */ 00036 class OWCOMMON_EXPORT WProjectFileIO // NOLINT 00037 { 00038 public: 00039 00040 /** 00041 * Default constructor. 00042 */ 00043 WProjectFileIO(); 00044 00045 /** 00046 * Destructor. 00047 */ 00048 virtual ~WProjectFileIO(); 00049 00050 /** 00051 * This method parses the specified line and interprets it. It gets called line by line by WProjectFile. 00052 * 00053 * \param line the current line as string 00054 * \param lineNumber the current line number. Useful for error/warning/debugging output. 00055 * 00056 * \return true if the line could be parsed. 00057 */ 00058 virtual bool parse( std::string line, unsigned int lineNumber ) = 0; 00059 00060 /** 00061 * Called whenever the end of the project file has been reached. This is useful if your specific parser class wants to do some post 00062 * processing after parsing line by line. 00063 */ 00064 virtual void done(); 00065 00066 /** 00067 * Saves the state to the specified stream. 00068 * 00069 * \param output the stream to print the state to. 00070 */ 00071 virtual void save( std::ostream& output ) = 0; // NOLINT 00072 00073 protected: 00074 00075 private: 00076 }; 00077 00078 #endif // WPROJECTFILEIO_H 00079