path: root/src/mds-kbdc/call-stack.h

/**
 * mds — A micro-display server
 * Copyright © 2014, 2015  Mattias Andrée (maandree@member.fsf.org)
 * 
 * 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/>.
 */
#ifndef MDS_MDS_KBDC_CALL_STACK_H
#define MDS_MDS_KBDC_CALL_STACK_H


#include "parsed.h"
#include "include-stack.h"



/**
 * Add “called from here”-notes
 */
#define DUMP_CALL_STACK			\
  fail_if (mds_kbdc_call_stack_dump())



/**
 * Add “called from here”-notes
 * 
 * @return  Zero on success, -1 on error
 */
int mds_kbdc_call_stack_dump(void);

/**
 * Prepare for usage of call-stacks
 * 
 * @param  result  The `result` parameter of root procedure that requires the call-stack
 */
void mds_kbdc_call_stack_begin(mds_kbdc_parsed_t* restrict result);

/**
 * Cleanup after usage of call-stacks
 */
void mds_kbdc_call_stack_end(void);

/**
 * Mark an function- or macro-call
 * 
 * @param   tree   The tree node where the call was made
 * @param   start  The position of the line of the tree node where the call begins
 * @param   end    The position of the line of the tree node where the call end
 * @return         Zero on success, -1 on error
 */
int mds_kbdc_call_stack_push(const mds_kbdc_tree_t* restrict tree, size_t start, size_t end);

/**
 * Undo the lasted not-undone call to `mds_kbdc_call_stack_push`
 * 
 * This function is guaranteed not to modify `errno`
 */
void mds_kbdc_call_stack_pop(void);



#endif