79b1407e23
The underlying iterators were default constructed (aka uninitialised) when a Deck was default constructed, meaning possible invocation of undefined behaviour. While the empty Deck typically is only used for testing, this is a possible bug in production code. This small patch makes sure even default constructed Decks are well defined.
125 lines
4.1 KiB
C++
125 lines
4.1 KiB
C++
/*
|
|
Copyright 2013 Statoil ASA.
|
|
|
|
This file is part of the Open Porous Media project (OPM).
|
|
|
|
OPM 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.
|
|
|
|
OPM 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 OPM. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef DECK_HPP
|
|
#define DECK_HPP
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
#include <vector>
|
|
#include <string>
|
|
|
|
#include <opm/parser/eclipse/Deck/DeckKeyword.hpp>
|
|
#include <opm/parser/eclipse/Units/UnitSystem.hpp>
|
|
|
|
namespace Opm {
|
|
|
|
/*
|
|
* The Deck (container) class owns all memory given to it via .addX(), as
|
|
* do all inner objects. This means that the Deck object itself must stay
|
|
* alive as long as DeckItem (and friends) are needed, to avoid
|
|
* use-after-free.
|
|
*/
|
|
|
|
class DeckView {
|
|
public:
|
|
typedef std::vector< DeckKeyword >::const_iterator const_iterator;
|
|
|
|
bool hasKeyword( const DeckKeyword& keyword ) const;
|
|
bool hasKeyword( const std::string& keyword ) const;
|
|
template< class Keyword >
|
|
bool hasKeyword() const {
|
|
return hasKeyword( Keyword::keywordName );
|
|
}
|
|
|
|
const DeckKeyword& getKeyword( const std::string& keyword, size_t index ) const;
|
|
const DeckKeyword& getKeyword( const std::string& keyword ) const;
|
|
const DeckKeyword& getKeyword( size_t index ) const;
|
|
DeckKeyword& getKeyword( size_t index );
|
|
template< class Keyword >
|
|
const DeckKeyword& getKeyword() const {
|
|
return getKeyword( Keyword::keywordName );
|
|
}
|
|
template< class Keyword >
|
|
const DeckKeyword& getKeyword( size_t index ) const {
|
|
return getKeyword( Keyword::keywordName, index );
|
|
}
|
|
|
|
const std::vector< const DeckKeyword* > getKeywordList( const std::string& keyword ) const;
|
|
template< class Keyword >
|
|
const std::vector< const DeckKeyword* > getKeywordList() const {
|
|
return getKeywordList( Keyword::keywordName );
|
|
}
|
|
|
|
size_t count(const std::string& keyword) const;
|
|
size_t size() const;
|
|
|
|
const_iterator begin() const;
|
|
const_iterator end() const;
|
|
|
|
protected:
|
|
void add( const DeckKeyword*, const_iterator, const_iterator );
|
|
|
|
const std::vector< size_t >& offsets( const std::string& ) const;
|
|
|
|
DeckView( const_iterator first, const_iterator last );
|
|
DeckView( std::pair< const_iterator, const_iterator > );
|
|
|
|
private:
|
|
const_iterator first;
|
|
const_iterator last;
|
|
std::map< std::string, std::vector< size_t > > keywordMap;
|
|
|
|
};
|
|
|
|
class Deck : private DeckView {
|
|
public:
|
|
using DeckView::const_iterator;
|
|
using DeckView::hasKeyword;
|
|
using DeckView::getKeyword;
|
|
using DeckView::getKeywordList;
|
|
using DeckView::count;
|
|
using DeckView::size;
|
|
using DeckView::begin;
|
|
using DeckView::end;
|
|
|
|
Deck();
|
|
void addKeyword( DeckKeyword&& keyword );
|
|
void addKeyword( const DeckKeyword& keyword );
|
|
|
|
DeckKeyword& getKeyword( size_t );
|
|
|
|
void initUnitSystem();
|
|
UnitSystem& getDefaultUnitSystem() const;
|
|
UnitSystem& getActiveUnitSystem() const;
|
|
|
|
private:
|
|
Deck( std::vector< DeckKeyword >&& );
|
|
|
|
std::vector< DeckKeyword > keywordList;
|
|
std::unique_ptr< UnitSystem > activeUnits;
|
|
std::unique_ptr< UnitSystem > defaultUnits;
|
|
};
|
|
|
|
typedef std::shared_ptr<Deck> DeckPtr;
|
|
typedef std::shared_ptr<const Deck> DeckConstPtr;
|
|
}
|
|
#endif /* DECK_HPP */
|
|
|