/*****************************************************************************/
/*                                                                           */
/*                                  span.h                                   */
/*                                                                           */
/*                      A span of data within a segment                      */
/*                                                                           */
/*                                                                           */
/*                                                                           */
/* (C) 2011,      Ullrich von Bassewitz                                      */
/*                Roemerstrasse 52                                           */
/*                D-70794 Filderstadt                                        */
/* EMail:         uz@cc65.org                                                */
/*                                                                           */
/*                                                                           */
/* This software is provided 'as-is', without any expressed or implied       */
/* warranty.  In no event will the authors be held liable for any damages    */
/* arising from the use of this software.                                    */
/*                                                                           */
/* Permission is granted to anyone to use this software for any purpose,     */
/* including commercial applications, and to alter it and redistribute it    */
/* freely, subject to the following restrictions:                            */
/*                                                                           */
/* 1. The origin of this software must not be misrepresented; you must not   */
/*    claim that you wrote the original software. If you use this software   */
/*    in a product, an acknowledgment in the product documentation would be  */
/*    appreciated but is not required.                                       */
/* 2. Altered source versions must be plainly marked as such, and must not   */
/*    be misrepresented as being the original software.                      */
/* 3. This notice may not be removed or altered from any source              */
/*    distribution.                                                          */
/*                                                                           */
/*****************************************************************************/



#ifndef SPAN_H
#define SPAN_H



#include <stdio.h>

/* common */
#include "coll.h"



/*****************************************************************************/
/*                                 Forwards                                  */
/*****************************************************************************/



struct ObjData;
struct Segment;



/*****************************************************************************/
/*                                   Data                                    */
/*****************************************************************************/



/* Span is an opaque type */
typedef struct Span Span;



/*****************************************************************************/
/*                                   Code                                    */
/*****************************************************************************/



Span* ReadSpan (FILE* F, struct ObjData* O, unsigned Id);
/* Read a Span from a file and return it */

unsigned* ReadSpanList (FILE* F);
/* Read a list of span ids from a file. The list is returned as an array of
 * unsigneds, the first being the number of spans (never zero) followed by
 * the span ids. If the number of spans is zero, NULL is returned.
 */

unsigned* DupSpanList (const unsigned* S);
/* Duplicate a span list */

void FreeSpan (Span* S);
/* Free a span structure */

unsigned SpanCount (void);
/* Return the total number of spans */

void PrintDbgSpanList (FILE* F, const struct ObjData* O, const unsigned* List);
/* Output a string ",span=x[+y...]" for the given list. If the list is empty
 * or NULL, output nothing. This is a helper function for other modules to
 * print a list of spans read by ReadSpanList to the debug info file.
 */

void PrintDbgSpans (FILE* F);
/* Output the spans to a debug info file */



/* End of span.h */
#endif



