///
/// @file log_api.h
/// @authors k. headley
/// @date 05 dec 2019

/// Structure independent log navigation API
/// used by log utils, uses log_impl API(s)

/// @sa doxygen-examples.c for more examples of Doxygen markup


/////////////////////////
// Terms of use
/////////////////////////
/*
 Copyright Information
  
 Copyright 2002-2019 MBARI
 Monterey Bay Aquarium Research Institute, all rights reserved.
 
 Terms of Use
 
 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. You can access the GPLv3 license at
 http://www.gnu.org/licenses/gpl-3.0.html
 
 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
 (http://www.gnu.org/licenses/gpl-3.0.html)
 
 MBARI provides the documentation and software code "as is", with no warranty,
 express or implied, as to the software, title, non-infringement of third party
 rights, merchantability, or fitness for any particular purpose, the accuracy of
 the code, or the performance or results which you may obtain from its use. You
 assume the entire risk associated with use of the code, and you agree to be
 responsible for the entire cost of repair or servicing of the program with
 which you are using the code.
 
 In no event shall MBARI be liable for any damages, whether general, special,
 incidental or consequential damages, arising out of your use of the software,
 including, but not limited to, the loss or corruption of your data or damages
 of any kind resulting from use of the software, any prohibited use, or your
 inability to use the software. You agree to defend, indemnify and hold harmless
 MBARI and its officers, directors, and employees against any claim, loss,
 liability or expense, including attorneys' fees, resulting from loss of or
 damage to property or the injury to or death of any person arising out of the
 use of the software.
 
 The MBARI software is provided without obligation on the part of the
 Monterey Bay Aquarium Research Institute to assist in its use, correction,
 modification, or enhancement.
 
 MBARI assumes no responsibility or liability for any third party and/or
 commercial software required for the database or applications. Licensee agrees
 to obtain and maintain valid licenses for any additional third party software
 required.
 */

// Always do this
#ifndef LOG_API_H
#define LOG_API_H

/////////////////////////
// Includes 
/////////////////////////
#include "log_impl.h"

/////////////////////////
// Macros
/////////////////////////
#define LOG_SET_FLAG(p,m) (p->flags |= m )
#define LOG_CLR_FLAG(p,m) (p->flags &= ~(m))
#define LOG_ISSET_FLAG(p,m) ( (NULL!=p) && ((p->flags&m) != 0) ? true : false)
#define LOG_ISCLR_FLAG(p,m) ( (NULL!=p) && ((p->flags&m) == 0) ? true : false)
#define LOG_FLAGS(p,m) (NULL!=p ? p->flags&(m) : 0)

/////////////////////////
// Type Definitions
/////////////////////////


typedef enum {
    LCTX_WRAP_EN = 0x1,
    LCTX_DIR     = 0x2
}log_ctx_flags_t;


typedef struct log_ctx_s{
    log_ofs_t cur[CUR_COUNT];
    uint32_t length;
    log_ctx_flags_t flags;
    log_impl_t *impl;
    char *show_fmt;
    char *search_def;
}log_ctx_t;

/////////////////////////
// Exports
/////////////////////////

#ifdef __cplusplus
extern "C" {
#endif

    void lctx_set_impl(log_ctx_t *self, log_impl_t *impl);
    int lctx_init(log_ctx_t *self, char *fpath, log_impl_t *impl, lutil_type_id type);
    uint32_t lctx_fsize(log_ctx_t *self);
    uint32_t lctx_length(log_ctx_t *self);
    void lctx_set_wrap(log_ctx_t *self, bool wrap_en);
    uint32_t lctx_tell(log_ctx_t *self);
    int lctx_seek(log_ctx_t *self, log_dir_t dir, uint32_t start, uint32_t count);
    int lctx_next(log_ctx_t *self);
    int lctx_prev(log_ctx_t *self);
    int lctx_search(log_ctx_t *self, char *def_str, log_dir_t dir);
    int lctx_read(log_ctx_t *self, byte *dest, uint32_t len, uint32_t count);
    int lctx_show(log_ctx_t *self, int indent, char **opts);
    int lctx_show_info(log_ctx_t *self, int indent, char **opts);

#ifdef __cplusplus
}
#endif

#endif // THIS_FILE
