/* BEGIN software license
 *
 * MsXpertSuite - mass spectrometry software suite
 * -----------------------------------------------
 * Copyright(C) 2009,...,2026 Filippo Rusconi
 *
 * http://www.msxpertsuite.org
 *
 * This file is part of the MsXpertSuite project.
 *
 * The MsXpertSuite project is the successor of the massXpert project. This
 * project now includes various independent modules:
 *
 * - MassXpert, model polymer chemistries and simulate mass spectrometric data;
 * - MineXpert, a powerful TIC chromatogram/mass spectrum viewer/miner;
 *
 * 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/>.
 *
 * END software license
 */


/////////////////////// Qt includes
#include <QFile>
#include <QDebug>


/////////////////////// Local includes
#include "CrossLinkerSpec.hpp"


namespace MsXpS
{
namespace MassXpert
{


/*!
\class MsXpS::MassXpert::CrossLinkerSpec
\inmodule MassXpert
\ingroup PolChemDefBuildingdBlocks
\inheaderfile CrossLinkerSpec.hpp

\brief The CrossLinkerSpec class provides the specification about how \l
CrossLinker objects are represented.

The CrossLinkerSpec class specifies how a \l CrossLinker object is represented
graphically, mainly by connecting its name to a graphics SVG file that
is located in the Polymer chemistry definition directory. That connection is
performed in the "cross_linker_dictionary" dictionary file itself also located
in the polymer chemistry definition directory. Its contents look like this:

\code
DisulfideBond%disulfidebond-cross-link.svg
CFP-chromophore%cfp-chromophore.svg
\endcode

The \c{DisulfideBond%disulfidebond-cross-link.svg} line indicates that, when a
CrossLinker object by name "DisulfideBond" is
to be rendered graphically, the corresponding vignette to be used is in the
file named "disulfidebond-cross-link.svg" in the polymer chemistry definition
directory.
*/


/*!
\variable int MsXpS::libXpertMassCore::CrossLinkerSpec::m_name

\brief The name of the cross-linker.
*/

/*!
\variable int MsXpS::libXpertMassCore::CrossLinkerSpec::m_vector

\brief The filename of the vector representation of the cross-linker.
*/

/*!
\variable int MsXpS::libXpertMassCore::CrossLinkerSpec::m_sound

\brief The file name of the sound for the cross-linker.
*/


/*!
\brief Constructs a CrossLinkerSpec instance.
*/
CrossLinkerSpec::CrossLinkerSpec()
{
}

/*!
\brief Destructs this CrossLinkerSpec instance.
*/
CrossLinkerSpec::~CrossLinkerSpec()
{
}

/*!
\brief Sets the cross-linker \a name.
*/
void
CrossLinkerSpec::setName(const QString &name)
{
  m_name = name;
}

/*
\brief Gets the cross-linker name.
*/
const QString &
CrossLinkerSpec::getName() const
{
  return m_name;
}


/*!
\brief Sets the vector image file name to \a vector.
*/
void
CrossLinkerSpec::setVector(const QString &vector)
{
  m_vector = vector;
}


/*!
\brief Returns the vector image file name.
*/
const QString &
CrossLinkerSpec::getVector() const
{
  return m_vector;
}


/*!
\brief Sets the file name of the CrossLinkerSpec's \a sound file.
*/
void
CrossLinkerSpec::setSound(const QString &sound)
{
  m_sound = sound;
}


/*!
\brief Returns the file name of the CrossLinkerSpec's sound file.
*/
const QString &
CrossLinkerSpec::getSound() const
{
  return m_sound;
}


/*!
\brief Parses the \a file_path dictionary containing the \l CrossLinker
specifications.

At the moment the file has this format:

\code
DisulfideBond%disulfidebond-cross-link.svg
CFP-chromophore%cfp-chromophore.svg
\endcode

Upon parsing, the \a cross_linker_spec_list of CrossLinkerSpec instances will
be filled with
instances created on the basis of each parsed line in the file.

Returns true if the parsing was successful, false otherwise.
*/
bool
CrossLinkerSpec::parseFile(const QString &file_path,
                           std::vector<CrossLinkerSpec> &cross_linker_specs)
{
  CrossLinkerSpec cross_linker_spec;

  qint64 lineLength;

  QString line;
  QString temp;

  char buffer[1024];

  int percentSignIdx = 0;

  if(file_path.isEmpty())
    return false;

  QFile file(file_path);

  if(!file.open(QFile::ReadOnly))
    return false;

  // The lines we have to parse are of the following type:
  // DisulfideBon%disulfidebond.svg
  // Any line starting with ' ' or '#' are not parsed.

  // Get the first line of the file. Next we enter in to a
  // while loop.

  lineLength = file.readLine(buffer, sizeof(buffer));

  while(lineLength != -1)
    {
      // The line is now in buffer, and we want to convert
      // it to Unicode by setting it in a QString.
      line = buffer;

      // The line that is in line should contain something like:
      // DisulfideBon%disulfidebond.svg
      //
      // Note, however that lines beginning with either '\n'(newline)
      // or '#' are comments.

      // Remove all the spaces from the borders: Whitespace means any
      // character for which QChar::isSpace() returns true. This
      // includes the ASCII characters '\t', '\n', '\v', '\f', '\r',
      // and ' '.

      line = line.trimmed();

      if(line.isEmpty() || line.startsWith('#', Qt::CaseInsensitive))
        {
          lineLength = file.readLine(buffer, sizeof(buffer));
          continue;
        }

      // Now some other checks. Remember the format of the line:
      // DisulfideBon%disulfidebond.svg

      percentSignIdx = line.indexOf('%', 0, Qt::CaseInsensitive);

      if(percentSignIdx == -1 || line.count('%', Qt::CaseInsensitive) > 2)
        return false;

      cross_linker_spec.m_name = line.left(percentSignIdx);

      // Remove from the line the "DisulfideBond%" substring, as we
      // do not need it anymore.
      line.remove(0, percentSignIdx + 1);

      // Now we can go on with the graphics files stuff. At this point
      // all that remains up to the end of the line is the filename
      // with extension .svg.

      if(!line.endsWith(".svg", Qt::CaseSensitive))
        {
          return false;
        }

      // Ok that's done, we can get the vector graphics filename:

      cross_linker_spec.m_vector = line;

      cross_linker_specs.push_back(cross_linker_spec);

      // Continue to next line to further parse the file.
      lineLength = file.readLine(buffer, sizeof(buffer));
    }

  return true;
}

} // namespace MassXpert

} // namespace MsXpS
