mirror of
https://github.com/OPM/ResInsight.git
synced 2026-10-25 14:40:26 -05:00
Magne Sjaastad
5356f078a5
Enhanced parsing in PdmFieldScriptingCapabilityIOHandler to correctly handle backslashes and escape sequences in both quoted and unquoted strings. Unquoted Windows paths now preserve backslashes, while quoted strings process escape sequences as expected. Added unit tests to verify correct handling of both cases. Add tests for Windows-style path handling in rips API Introduce test_windows_paths.py with two pytest tests to verify correct handling of Windows-style file paths (backslashes) in the rips Python API.
276 lines
13 KiB
C++
276 lines
13 KiB
C++
//##################################################################################################
|
|
//
|
|
// Custom Visualization Core library
|
|
// Copyright (C) Ceetron Solutions AS
|
|
//
|
|
// This library may be used under the terms of either the GNU General Public License or
|
|
// the GNU Lesser General Public License as follows:
|
|
//
|
|
// GNU General Public License Usage
|
|
// This library 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 library 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 at <<http://www.gnu.org/licenses/gpl.html>>
|
|
// for more details.
|
|
//
|
|
// GNU Lesser General Public License Usage
|
|
// This library 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 2.1 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This library 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 at <<http://www.gnu.org/licenses/lgpl-2.1.html>>
|
|
// for more details.
|
|
//
|
|
//##################################################################################################
|
|
#include "cafPdmFieldScriptingCapability.h"
|
|
|
|
using namespace caf;
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void PdmFieldScriptingCapabilityIOHandler<QString>::writeToField( QString& fieldValue,
|
|
QTextStream& inputStream,
|
|
caf::PdmScriptIOMessages* errorMessageContainer,
|
|
bool stringsAreQuoted,
|
|
bool allowExtraCharacters )
|
|
{
|
|
fieldValue = "";
|
|
|
|
errorMessageContainer->skipWhiteSpaceWithLineNumberCount( inputStream );
|
|
QString accumulatedFieldValue;
|
|
|
|
QChar currentChar;
|
|
bool validStringStart = !stringsAreQuoted;
|
|
bool validStringEnd = !stringsAreQuoted;
|
|
if ( stringsAreQuoted )
|
|
{
|
|
currentChar = errorMessageContainer->readCharWithLineNumberCount( inputStream );
|
|
if ( currentChar == QChar( '"' ) )
|
|
{
|
|
validStringStart = true;
|
|
}
|
|
}
|
|
|
|
if ( validStringStart )
|
|
{
|
|
while ( !inputStream.atEnd() )
|
|
{
|
|
currentChar = errorMessageContainer->readCharWithLineNumberCount( inputStream );
|
|
|
|
if ( currentChar.isNull() )
|
|
{
|
|
// Null character - add as is
|
|
accumulatedFieldValue += currentChar;
|
|
}
|
|
else if ( currentChar == QChar( '"' ) )
|
|
{
|
|
// End Quote - reached end of string
|
|
validStringEnd = true;
|
|
break;
|
|
}
|
|
else if ( currentChar == QChar( '\\' ) && stringsAreQuoted )
|
|
{
|
|
// Process escape sequence only when strings are quoted
|
|
// Read the next character after the backslash
|
|
if ( !inputStream.atEnd() )
|
|
{
|
|
currentChar = errorMessageContainer->readCharWithLineNumberCount( inputStream );
|
|
accumulatedFieldValue += currentChar;
|
|
}
|
|
else
|
|
{
|
|
// Backslash at end of input - add it as is
|
|
accumulatedFieldValue += QChar( '\\' );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Regular character (including backslashes when strings are not quoted)
|
|
accumulatedFieldValue += currentChar;
|
|
}
|
|
}
|
|
}
|
|
if ( !validStringStart )
|
|
{
|
|
// Unexpected start of string, Missing '"'
|
|
// Error message
|
|
errorMessageContainer->addError(
|
|
"String argument does not seem to be quoted. Missing the start '\"' in the \"" +
|
|
errorMessageContainer->currentArgument + "\" argument of the command: \"" +
|
|
errorMessageContainer->currentCommand + "\"" );
|
|
// Could interpret as unquoted text
|
|
}
|
|
else if ( !validStringEnd )
|
|
{
|
|
// Unexpected end of string, Missing '"'
|
|
// Error message
|
|
errorMessageContainer->addError( "String argument does not seem to be quoted. Missing the end '\"' in the \"" +
|
|
errorMessageContainer->currentArgument + "\" argument of the command: \"" +
|
|
errorMessageContainer->currentCommand + "\"" );
|
|
// Could interpret as unquoted text
|
|
}
|
|
|
|
if ( accumulatedFieldValue != "None" )
|
|
{
|
|
fieldValue = accumulatedFieldValue;
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void PdmFieldScriptingCapabilityIOHandler<QString>::readFromField( const QString& fieldValue,
|
|
QTextStream& outputStream,
|
|
bool quoteStrings,
|
|
bool quoteNonBuiltin )
|
|
{
|
|
outputStream << "\"";
|
|
for ( int i = 0; i < fieldValue.size(); ++i )
|
|
{
|
|
if ( fieldValue[i] == QChar( '"' ) || fieldValue[i] == QChar( '\\' ) )
|
|
{
|
|
outputStream << "\\";
|
|
}
|
|
outputStream << fieldValue[i];
|
|
}
|
|
outputStream << "\"";
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void PdmFieldScriptingCapabilityIOHandler<bool>::writeToField( bool& fieldValue,
|
|
QTextStream& inputStream,
|
|
caf::PdmScriptIOMessages* errorMessageContainer,
|
|
bool stringsAreQuoted,
|
|
bool allowExtraCharacters )
|
|
{
|
|
errorMessageContainer->skipWhiteSpaceWithLineNumberCount( inputStream );
|
|
QString accumulatedFieldValue;
|
|
QChar nextChar;
|
|
QChar currentChar;
|
|
while ( !inputStream.atEnd() )
|
|
{
|
|
nextChar = errorMessageContainer->peekNextChar( inputStream );
|
|
if ( nextChar.isLetter() )
|
|
{
|
|
currentChar = errorMessageContainer->readCharWithLineNumberCount( inputStream );
|
|
accumulatedFieldValue += currentChar;
|
|
}
|
|
else
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
// Accept TRUE or False in any case combination.
|
|
bool evaluatesToTrue = QString::compare( accumulatedFieldValue, QString( "true" ), Qt::CaseInsensitive ) == 0;
|
|
bool evaluatesToFalse = QString::compare( accumulatedFieldValue, QString( "false" ), Qt::CaseInsensitive ) == 0;
|
|
if ( evaluatesToTrue == evaluatesToFalse )
|
|
{
|
|
QString formatString(
|
|
"Boolean argument \"%1\" for the command \"%2\" does not evaluate to either true or false" );
|
|
QString errorMessage =
|
|
formatString.arg( errorMessageContainer->currentArgument ).arg( errorMessageContainer->currentCommand );
|
|
errorMessageContainer->addError( errorMessage );
|
|
}
|
|
else if ( !allowExtraCharacters )
|
|
{
|
|
errorMessageContainer->checkForExtraCharactersAfterValue( inputStream );
|
|
}
|
|
fieldValue = evaluatesToTrue;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void PdmFieldScriptingCapabilityIOHandler<bool>::readFromField( const bool& fieldValue,
|
|
QTextStream& outputStream,
|
|
bool quoteStrings,
|
|
bool quoteNonBuiltin )
|
|
{
|
|
// Lower-case true/false is used in the documentation.
|
|
outputStream << ( fieldValue ? "true" : "false" );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void PdmFieldScriptingCapabilityIOHandler<double>::writeToField( double& fieldValue,
|
|
QTextStream& inputStream,
|
|
PdmScriptIOMessages* errorMessageContainer,
|
|
bool stringsAreQuoted,
|
|
bool allowExtraCharacters )
|
|
{
|
|
inputStream >> fieldValue;
|
|
if ( inputStream.status() == QTextStream::ReadCorruptData )
|
|
{
|
|
errorMessageContainer->addError( "Argument value is unreadable in the argument: \"" +
|
|
errorMessageContainer->currentArgument + "\" in the command: \"" +
|
|
errorMessageContainer->currentCommand + "\"" );
|
|
|
|
inputStream.setStatus( QTextStream::Ok );
|
|
}
|
|
else if ( inputStream.status() == QTextStream::Ok && !allowExtraCharacters )
|
|
{
|
|
errorMessageContainer->checkForExtraCharactersAfterValue( inputStream );
|
|
}
|
|
}
|
|
|
|
void PdmFieldScriptingCapabilityIOHandler<double>::readFromField( const double& fieldValue,
|
|
QTextStream& outputStream,
|
|
bool quoteStrings,
|
|
bool quoteNonBuiltins )
|
|
{
|
|
// Use scientific for better precision
|
|
outputStream.setRealNumberPrecision( 15 );
|
|
outputStream.setRealNumberNotation( QTextStream::ScientificNotation );
|
|
outputStream << fieldValue;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void PdmFieldScriptingCapabilityIOHandler<int>::writeToField( int& fieldValue,
|
|
QTextStream& inputStream,
|
|
PdmScriptIOMessages* errorMessageContainer,
|
|
bool stringsAreQuoted,
|
|
bool allowExtraCharacters )
|
|
{
|
|
inputStream >> fieldValue;
|
|
if ( inputStream.status() == QTextStream::ReadCorruptData )
|
|
{
|
|
errorMessageContainer->addError( "Argument value is unreadable in the argument: \"" +
|
|
errorMessageContainer->currentArgument + "\" in the command: \"" +
|
|
errorMessageContainer->currentCommand + "\"" );
|
|
|
|
inputStream.setStatus( QTextStream::Ok );
|
|
}
|
|
else if ( inputStream.status() == QTextStream::Ok && !allowExtraCharacters )
|
|
{
|
|
errorMessageContainer->checkForExtraCharactersAfterValue( inputStream );
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void PdmFieldScriptingCapabilityIOHandler<int>::readFromField( const int& fieldValue,
|
|
QTextStream& outputStream,
|
|
bool quoteStrings,
|
|
bool quoteNonBuiltins )
|
|
{
|
|
outputStream << fieldValue;
|
|
}
|