macro_parse_functions.hpp

Go to the documentation of this file.

Go to the SVN repository for this file.

#ifndef GUI_OBJUTILS___MACRO_PARSE_FUNCTIONS__HPP
#define GUI_OBJUTILS___MACRO_PARSE_FUNCTIONS__HPP
/*  $Id: macro_parse_functions.hpp 46808 2021-10-20 20:54:24Z asztalos $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Authors: Andrea Asztalos
 *
 * File Description: 
 *
 */
 
#include <corelib/ncbistd.hpp>
#include <gui/objutils/macro_rep.hpp>
#include <gui/gui_export.h>
 
 
BEGIN_NCBI_SCOPE
 
/// Structure to store parsed function name and its arguments - as it appears in the macro
/// It is used when a macro is about to be opened in the macro editor, it does not play a role
/// When a macro is parsed.
 
struct SMacroFuncWithArgs : public CObject
{
    using TArgs = vector<string>;
    SMacroFuncWithArgs(const string& func_name) : m_FuncName(func_name) {}
    SMacroFuncWithArgs() {}
    SMacroFuncWithArgs(const SMacroFuncWithArgs&);
 
    bool operator==(const SMacroFuncWithArgs&) const;
    
    string m_FuncName;
    TArgs m_FuncArgs;
    bool m_Negate { false }; // set to true when the function is negated, used in constraints
    string m_ParentFnc; 
    CRef<SMacroFuncWithArgs> m_ChildFnc{ nullptr }; // to describe nested functions (used in constraints)
};
 
NCBI_GUIWIDGETS_EDIT_EXPORT CNcbiOstream& operator<<(CNcbiOstream& ostrm, const SMacroFuncWithArgs& f_args);
 
using TMacroFuncList = vector<SMacroFuncWithArgs>;
 
namespace NMFncParse {
    /// Temporary function name to return the relevant information from the Where clause
    const string kPlaceHolderFn = "FieldPlaceHolder";
    
    const string kRnaTypeFn = "RNATypePlaceHolder";
 
    const string kncRNAclassFn = "ncRNAclassPlaceHolder";
 
    const string kFeatTypeFn = "FeatureTypePlaceHolder";
 
    const string kComparisonOp = "ComparisonOperator";
 
    /// Returns the list of do-functions present in the DO clause of the macro - includes multiples
    vector<string> GetDoFunctions(const macro::CMacroRep& macro_rep);
 
    /// Returns the list of DO functions and their arguments as they appear in the macro
    TMacroFuncList GetDoFunctionsWithArgs(const macro::CMacroRep& macro_rep, TMacroFuncList& do_constraints);
    /// Returns the list of WHERE functions and their arguments as they appear in the macro
    TMacroFuncList GetWhereFunctionsWithArgs(const macro::CMacroRep& macro_rep);
    /// Looks up variables names used as function arguments and substitutes their name with their values
    void LookupFncArguments(const macro::CMacroRep& macro_rep, TMacroFuncList& func_list);
}
 
END_NCBI_SCOPE
 
#endif  // GUI_OBJUTILS___MACRO_PARSE_FUNCTIONS__HPP