snippet.h

/* Jazz (c) 2018-2026 kaalam.ai (The Authors of Jazz), using (under the same license):
 
    1. Biomodelling - The AATBlockQueue class (c) Jacques Basaldúa, 2009-2012 licensed
      exclusively for the use in the Jazz server software.
 
      Copyright 2009-2012 Jacques Basaldúa
 
    2. BBVA - Jazz: A lightweight analytical web server for data-driven applications.
 
      Copyright 2016-2017 Banco Bilbao Vizcaya Argentaria, S.A.
 
      This product includes software developed at
 
      BBVA (https://www.bbva.com/)
 
    3. LMDB, Copyright 2011-2017 Howard Chu, Symas Corp. All rights reserved.
 
      Licensed under http://www.OpenLDAP.org/license.html
 
 
      Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
      http://www.apache.org/licenses/LICENSE-2.0
 
      Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/
 
 
#include "src/jazz_core/opcodes.h"
 
#if defined CATCH_TEST
#ifndef INCLUDED_JAZZ_CATCH2
#define INCLUDED_JAZZ_CATCH2
 
#include "src/catch2/catch.hpp"
 
#endif
#endif
 
 
#ifndef INCLUDED_JAZZ_BEBOP_SNIPPET
#define INCLUDED_JAZZ_BEBOP_SNIPPET
 
 
//TODO: Synchronize http://localhost:8888/jazz_reference/api_ref_core.html (Erase this only when Core is done.)
 
namespace jazz_core
{
 
const char KIND_SNIPPET[]   = "{\"object\" : BYTE[obj_size], \"body\" : STRING[body_len], \"calls\" : STRING[calls_len]," \
                              "\"input\" : STRING[input_len], \"output\" : STRING[output_len], \"reads\" : STRING[reads_len]," \
                              "\"source\" : STRING[source_len], \"writes\" : STRING[writes_len]}";
 
const char EMPTY_SNIPPET[]  = "(\"object\" : [], \"body\" : [NA], \"calls\" : [NA], \"input\" : [NA], \"output\" : [NA]," \
                              "\"reads\" : [NA], \"source\" : [NA], \"writes\" : [NA])";
 
const char SNIPPET_VERSION[]                = "snp1";   
 
const char SNIPSTATE_EMPTY_SNIPPET[]        = "____";   
const char SNIPSTATE_SOURCE_AVAILABLE[]     = "s___";   
const char SNIPSTATE_SOURCE_PREPROCESSED[]  = "sx__";   
const char SNIPSTATE_SOURCE_COMPILED[]      = "sxo_";   
const char SNIPSTATE_OBJECT_AVAILABLE[]     = "__o_";   
const char SNIPSTATE_OBJECT_PREPROCESSED[]  = "_xo_";   
const char SNIPSTATE_CAN_RUN[]              = "___a";   
const char SNIPSTATE_CAN_RUN_OBJECT[]       = "_xor";   
const char SNIPSTATE_CAN_RUN_SOURCE[]       = "sxor";   
const char SNIPSTATE_IS_RUNNING_OBJECT[]    = "_xoi";   
const char SNIPSTATE_IS_RUNNING_SOURCE[]    = "sxoi";   
const char SNIPSTATE_FAILED_SRC_PREPROC[]   = "sX_!";   
const char SNIPSTATE_FAILED_SRC_COMPILE[]   = "sxO!";   
const char SNIPSTATE_FAILED_OBJ_PREPROC[]   = "_Xo!";   
const char SNIPSTATE_FAILED_RUN_OBJECT[]    = "_xo!";   
const char SNIPSTATE_FAILED_RUN_SOURCE[]    = "sxo!";   
 
#define MASK_SNIPSTATE_GENERAL  0xff000000              
#define MASK_SNIPSTATE_OBJECT   0x00ff0000              
#define MASK_SNIPSTATE_INTER    0x0000ff00              
#define MASK_SNIPSTATE_SOURCE   0x000000ff              
#define SNIPSTATE_UNDEFINED     0x7fffffff              
 
#define SNIP_INDEX_OBJECT       0                       
#define SNIP_INDEX_BODY         1                       
#define SNIP_INDEX_CALLS        2                       
#define SNIP_INDEX_INPUT        3                       
#define SNIP_INDEX_OUTPUT       4                       
#define SNIP_INDEX_READS        5                       
#define SNIP_INDEX_SOURCE       6                       
#define SNIP_INDEX_WRITES       7                       
 
#define BLOCK_ATTRIB_SNIPSTATE  (BLOCK_ATTRIB_BASE_BOP + 1)     
#define BLOCK_ATTRIB_SNIPVERS   (BLOCK_ATTRIB_BASE_BOP + 2)     
 
typedef std::vector<String> SnippetText;
typedef SnippetText *pSnippetText;              
 
 
class Snippet : public Tuple {
 
    public:
 
        using Tuple::get_block;
 
        int   get_state();
        bool  get_block(int idx, SnippetText &snip_text);
        bool  get_block(pChar name, SnippetText &snip_text);
        int   object_size();
        void* get_object();
};
typedef Snippet *pSnippet;      
 
} // namespace jazz_core
 
#endif // ifndef INCLUDED_JAZZ_BEBOP_SNIPPET