SFBPrint.h

Go to the documentation of this file.

/*                                              -*- mode:C++; fill-column:100 -*-
  SFBPrint.h - Generalized print formatting routines
  Copyright (C) 2009 The Regents of the University of New Mexico.  All rights reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  USA

  $Id$
*/

#ifndef SFBPRINT_H
#define SFBPRINT_H

#include "SFBConstants.h"       /* For FACE_COUNT */
#include "SFBAlarm.h"           /* For SFBAlarmIndexType */ 
#include "SFBReactor.h"         /* For PacketHandler, Body */ 
#include "SFBFrame.h"

/* The 'plain function' print methods dish to all reflex-controlled faces! */

extern void print(const char * str);            

extern void print(const u8 * str, u32 len);     

extern void print(int decimal);                 

extern void print(unsigned int decimal);        

extern void print(long decimal);                

extern void print(unsigned long decimal);       

extern void print(long decimal, int code);      

extern void print(double val);                  

extern void printFace();                        


extern void printPacket(u8 * packet);           


extern void println();                          

extern void println(const char * str);          

extern void println(const u8 * str, u32 len);   

extern void println(int decimal);               

extern void println(unsigned int decimal);      

extern void println(long decimal);              

extern void println(unsigned long decimal);     

extern void println(long decimal, int code);    

extern void println(double val);                

extern void printlnCheckByte();                 


extern void facePrint(u8 face, const char * str);
extern void facePrint(u8 face, const u8 * str, u32 len);
extern void facePrint(u8 face, int decimal); 
extern void facePrint(u8 face, unsigned int decimal);
extern void facePrint(u8 face, long decimal);
extern void facePrint(u8 face, unsigned long decimal);
extern void facePrintBinary(u8 face, u64 value);
//extern void facePrint(u8 face, long decimal, int code);
extern void facePrint(u8 face, unsigned long decimal, int code);
extern void facePrint(u8 face, unsigned long decimal, int code, bool printneg, int width, bool zerofill);
extern void facePrint(u8 face, double val);
extern void facePrint(u8 face, double val);
extern void facePrintFace(u8 face);
extern void facePrintPacket(u8 face, const u8 * packet);
extern void facePrintPacketHeader(u8 face, u32 packetLen, u8 sourceFace = NORTH, u8 cursor = 0, u8 flags = 0);

extern void facePrintln(u8 face); 
extern void facePrintln(u8 face, const char * str);        

extern void facePrintln(u8 face, const u8 * str, u32 len); 

extern void facePrintln(u8 face, int decimal);             

extern void facePrintln(u8 face, unsigned int decimal);    

extern void facePrintln(u8 face, long decimal);            

extern void facePrintln(u8 face, unsigned long decimal);   

extern void facePrintln(u8 face, unsigned long decimal, int code);
extern void facePrintln(u8 face, double val);              

extern void facePrintlnCheckByte(u8 face);

struct FacePrinter {
  void (*print)(u8 face, u8 byte);  
  void (*println)(u8 face);         
  void (*printFaceCode)(u8 face);   

  const char * (*getFaceName)(u8 face); 

};

extern bool faceHasPrinter(u8 face);     


extern const FacePrinter * faceGetPrinter(u8 face);

extern bool faceFindFreeFace(u8 & foundFace);

extern void faceSetPrinter(u8 face, const FacePrinter * handler) ;

extern void faceUnsetPrinter(u8 face) ;

struct PacketPrinterHeader {
  FacePrinter fp;               // A FacePrinter instance must be first (to allow bogus casting)
  u8 maxLen;
  u8 usedLen;
  u8 sourceFace;                // WARNING! sourceFace must be the last field of the struct!
  // u8 packetBuffer[0]; /* Illegal ISO C++, but just so you know: Packet buffer starts here. */
};

extern void packetPrinterStoreDataByte(PacketPrinterHeader *pph, u8 byte) ;

extern void packetPrinterTerminatePacket(PacketPrinterHeader *pph) ;

extern u8 * packetPrinterPrintedPacket(PacketPrinterHeader *pph) ;

#define PACKET_PRINTER_BUFFER_OVERHEAD_BYTES \
  (sizeof(PacketPrinterHeader)+sizeof(PacketHeader)+3+1) // (up to) 3 for alignment + 1 null terminator

#define PACKET_PRINTER_PACKET_BUFFER_SIZE \
  (PACKET_PRINTER_BUFFER_OVERHEAD_BYTES+MAX_PACKET_LENGTH) // room for a full packet

extern u8 * makePacketPrinter(u8 & assignedFace, u8 * buffer, u32 bufferLength, u8 sourceFace) ;

extern PacketPrinterHeader * initializePacketPrinterBuffer(const FacePrinter * fp, u8 onFace, u8 * buffer, u32 bufferLength, u8 sourceFace) ;

/* The one-time serial startup code */
extern void print_startup_initialization() ;

#endif  /* SFBPRINT_H */