/*
 * adiosFunctions.h Long helper functions used by ADIOS class
 *
 *  Created on: Oct 10, 2016
 *      Author: wfg
 */

#ifndef ADIOSFUNCTIONS_H_
#define ADIOSFUNCTIONS_H_

/// \cond EXCLUDE_FROM_DOXYGEN
#include <string>
#include <vector>
#include <map>
#include <cstring> //std::size_t
/// \endcond

#ifdef HAVE_MPI
  #include <mpi.h>
#else
  #include "mpidummy.h"
#endif


#include "core/Group.h"


namespace adios
{

/**
 * Opens and checks for file and dumps contents to a single string
 * @param fileName file to be opened
 * @param fileContents output contains the entire file
 */
void DumpFileToString( const std::string fileName, std::string& fileContents );


/**
 * Extracts a substring between two tags from content
 * @param initialTag
 * @param finalTag
 * @param content full string
 * @param subString if found return substring between initialTag and finalTag, otherwise returns empty
 * @param currentPosition to start the search, moved forward to finalTag position
 */
void GetSubString ( const std::string initialTag, const std::string finalTag, const std::string content, std::string& subString,
                    std::string::size_type& currentPosition );

/**
 * Extracts the value inside quotes in a string currentTag ( Example: currentTag --> field1="value1" field2="value2" )
 * @param quote double " or single '
 * @param quotePosition position of the opening quote in currentTag
 * @param currentTag initial tag value, modified by cutting the first found " " portion, currentTag --> field2="value2"
 * @param value value1 in the example above
 */
void GetQuotedValue( const char quote, const std::string::size_type& quotePosition,
                     std::string& currentTag, std::string& value );


/**
 * Get attributes field1="value1" field2="value2" by looping through a single XML tag
 * @param tag field0="value0" field1="value1" in a single string
 * @param pairs pairs[0].first=field0 pairs[0].second=value0 pairs[1].first=field1 pairs[1].second=value1
 */
void GetPairs( const std::string tag, std::vector< std::pair<const std::string, const std::string> >& pairs ) noexcept;


/**
 * Determine tag type and call GetPairs to populate pairs
 * @param fileContent file Content in a single string
 * @param tag field0="value0" field1="value1" in a single string
 * @param pairs pairs[0].first=field0 pairs[0].second=value0 pairs[1].first=field1 pairs[1].second=value1
 */
void GetPairsFromTag( const std::string& fileContent, const std::string tag,
                      std::vector< std::pair<const std::string, const std::string> >& pairs );


/**
 * Set members m_Groups and m_HostLanguage from XML file content, called within Init functions
 * @param fileContent file Content in a single string
 * @param mpiComm MPI Communicator passed from application passed to Transport method if required
 * @param hostLanguage return the host language from fileContent
 * @param transforms return the modified transforms vector if there are variables with transformations
 * @param groups passed returns the map of groups defined in fileContent
 */
void SetMembers( const std::string& fileContent, const MPI_Comm mpiComm,
                 std::string& hostLanguage, std::vector< std::shared_ptr<Transform> >& transforms,
                 std::map< std::string, Group >& groups );


/**
 * Called inside the ADIOS XML constructors to get contents from file, broadcast and set hostLanguage and groups from ADIOS class
 * @param xmlConfigFile xml config file name
 * @param mpiComm communicator used from broadcasting
 * @param debugMode from ADIOS m_DebugMode passed to CGroup in groups
 * @param hostLanguage set from host-language in xml file
 * @param transforms return the modified transforms vector if there are variables with transformations
 * @param groups passed returns the map of groups defined in fileContent
 */
void InitXML( const std::string xmlConfigFile, const MPI_Comm mpiComm, const bool debugMode,
              std::string& hostLanguage, std::vector< std::shared_ptr<Transform> >& transforms,
              std::map< std::string, Group >& groups );


/**
 * Loops through a vector containing dimensions and returns the product of all elements
 * @param dimensions input containing size on each dimension {Nx, Ny, Nz}
 * @return product of all dimensions Nx * Ny * Nz
 */
unsigned long long int GetTotalSize( const std::vector<unsigned long long int>& dimensions );


/**
 * Might need to add exceptions for debug mode
 * Creates a chain of directories using POSIX systems calls (stat, mkdir),
 * Verifies if directory exists before creating a new one. Permissions are 777 for now
 * @param fullPath /full/path/for/directory
 */
void CreateDirectory( const std::string fullPath ) noexcept;


/**
 * Identifies, verifies the corresponding transform method and adds it the transforms container if neccesary.
 * This functions must be updated as new transform methods are supported.
 * @param transform method to be added to transforms with format "method:compressionLevel", or  "method" with compressionLevel=0 (default)
 * @param transforms container of existing transform methods, owned by ADIOS class
 * @param debugMode if true will do more checks, exceptions, warnings, expect slower code
 * @param transformIndex returns the corresponding transformIndex in transforms for this transport method
 * @param compressionLevel returns the corresponding compression level from transport = "method:compressionLevel"
 */
void SetTransformHelper( const std::string transform, std::vector< std::shared_ptr<Transform> >& transforms,
                         const bool debugMode, int& transformIndex, int& compressionLevel );

/**
 * Check in types set if "type" is one of the aliases for a certain type, (e.g. if type = integer is an accepted alias for "int", returning true)
 * @param type input to be compared with an alias
 * @param types set containing aliases to a certain type, from Support.h
 * @return true: is an alias, false: is not
 */
bool IsTypeAlias( const std::string type, const std::set<std::string>& types );




} //end namespace



#endif /* ADIOSFUNCTIONS_H_ */