This file is indexed.

/usr/include/cigicl/CigiIncomingMsg.h is in libcigicl-dev 3.3.3a+svn818-7.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
/** <pre>
 *  The SDK is used to create and format CIGI compliant messages.
 *  Copyright (c) 2001-2005 The Boeing Company
 *  
 *  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 Public License for more 
 *  details.
 *  
 *  You should have received a copy of the GNU Lesser General Public License 
 *  along with this library; if not, write to the Free Software Foundation, 
 *  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *  
 *  FILENAME:   CigiIncomingMsg.h
 *  LANGUAGE:   C++
 *  CLASS:      UNCLASSIFIED
 *  PROJECT:    Common Image Generator Interface (CIGI) SDK
 *  
 *  PROGRAM DESCRIPTION: 
 *  ...
 *  
 *  MODIFICATION NOTES:
 *  DATE     NAME                                SCR NUMBER
 *  DESCRIPTION OF CHANGE........................
 *  
 *  09/17/2003 Greg Basler                       CIGI_CR_DR_1
 *  Initial Release.
 *  
 *  01/21/2005 Greg Basler                       Version 1.5
 *  Added the CIGI_SPEC modifier to the class declaration for exporting the 
 *  class in a Windows DLL.
 *  
 *  07/05/2005 Greg Basler                       Version 1.5.4
 *  Noted that the ProcessIncomingMsg function can throw exceptions, listed 
 *  in the comments section of the method.
 *
 *  10/28/2005 Greg Basler                       Version 1.5.7
 *  Corrected the description for SetReaderCigiVersion.
 *  
 *  04/14/2006 Greg Basler                       Version 1.7.0
 *  Added the GetReaderCigiMinorVersion accessor method.
 *  
 *  04/14/2006 Greg Basler                       Version 1.7.0
 *  Added an overloaded SetReaderCigiVersion method to accept a 
 *  CigiMinorVersionIn parameter.
 *  
 *  04/14/2006 Greg Basler                       Version 1.7.0
 *  Updated the existing SetReaderCigiVersion method to call the new 
 *  implementation with a default version number of 0.
 *  
 *  06/23/2006 Greg Basler                       Version 1.7.1
 *  Changed native char and unsigned char types to CIGI types Cigi_int8 and 
 *  Cigi_uint8.
 * </pre>
 *  Author: The Boeing Company
 *
 */

#if !defined(_CIGI_INCOMING_MESSAGE_INCLUDED_)
#define _CIGI_INCOMING_MESSAGE_INCLUDED_

#include <stdlib.h>
#include "CigiMessage.h"
#include "CigiMessageBuffer.h"
#include "CigiBaseEventProcessor.h"
#include "CigiBaseSignalProcessing.h"
#include "CigiSignalType.h"


//=========================================================
//! The formatting definition for all static callback functions
//!
typedef void (* CigiCBProcessor)(CigiBasePacket *Packet);


class CigiDefaultPacket;

class CigiSession;


//=========================================================
//! The class for incoming messages
//!
class CIGI_SPEC CigiIncomingMsg : public CigiMessage  
{

   friend class CigiSession;

public:


   //==> Management

   //=========================================================
   //! General Constructor
   //!
   CigiIncomingMsg();

   //=========================================================
   //! General Destructor
   //!
	virtual ~CigiIncomingMsg();



   //==> Processing Member functions


   //+> Processing Incoming Messages

   //=========================================================
   //! This processes the incoming message contained in a
   //!   user supplied buffer.<br>
   //! This routine can throw a CigiMissingIgControlException or
   //!   CigiMissingStartOfFrameException exception.
   //! \param Buff - Pointer to the beginning of the message
   //!    in a user supplied buffer.
   //! \param Size - Size in bytes of the message
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int ProcessIncomingMsg(Cigi_uint8 *Buff, int Size);

   //=========================================================
   //! This processes the incoming message using the internal buffer
   //! This can also throw the following exceptions:
   //!  - CigiMissingStartOfFrameException
   //!  - CigiMissingIgControlException
   //!  - CigiBufferOverrunException
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int ProcessIncomingMsg(void)
   {
      int Rslt = CIGI_ERROR_UNEXPECTED_NULL;
      if(CrntMsgBuf != NULL)
         Rslt = ProcessIncomingMsg(CrntMsgBuf->Buffer,
                                   CrntMsgBuf->BufferFillCnt);

      return(Rslt);
   }

   //=========================================================
   //! This processes the current packet.<br>
   //! This takes the given packet object and calls the correct
   //!   Event Managers, CallBacks, and Signals.
   //! \param PcktId - The packet id converted to the reader's
   //!    version of CIGI.
   //! \param Pckt - Pointer to the packet
   //!    in a user supplied buffer.
   //!
	void ProcessPacket(int PcktId, CigiBasePacket *Pckt);


   //+> Iterative packet processing method calls

   //=========================================================
   //! This gets the first packet of the message
   //!
   //! \return This returns a pointer to the first message
   //!
	CigiBasePacket * GetFirstPacket(void);

   //=========================================================
   //! This gets the next packet of the message
   //!
   //! \return This returns a pointer to the next message
   //!
	CigiBasePacket * GetNextPacket(void);


   //+> Packet Processor Management

   //=========================================================
   //! This places the specifed event method processor into
   //!   the event processor list for this packet.
   //! \param PacketID - The Packet ID to which the specified
   //!    event processor will be linked.
   //! \param EventMgr - A pointer to the event processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int RegisterEventProcessor(int PacketID,
                              CigiBaseEventProcessor *EventMgr);

   //=========================================================
   //! This removes the specifed event method processor from
   //!   the event processor list for this packet.
   //! \param PacketID - The Packet ID to which the specified
   //!    event processor is currently linked.
   //! \param EventMgr - A pointer to the event processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int UnregisterEventProcessor(int PacketID,
                              CigiBaseEventProcessor *EventMgr);


   //=========================================================
   //! This places the specifed callback method processor into
   //!   the callback processor list for this packet.
   //! \param PacketID - The Packet ID to which the specified
   //!    callback processor will be linked.
   //! \param CallBack - A pointer to the callback processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int RegisterCallBack(int PacketID, CigiCBProcessor CallBack);

   //=========================================================
   //! This removes the specifed callback method processor from
   //!   the callback processor list for this packet.
   //! \param PacketID - The Packet ID to which the specified
   //!    callback processor is currently linked.
   //! \param CallBack - A pointer to the callback processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int UnregisterCallBack(int PacketID, CigiCBProcessor CallBack);


   //=========================================================
   //! This places the specifed signal method processor into
   //!   the event processor list.
   //! \param SignalMgr - A pointer to the signal processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int RegisterSignalProcessor(CigiBaseSignalProcessing *SignalMgr);

   //=========================================================
   //! This removes the specifed signal method processor from
   //!   the signal processor list.
   //! \param SignalMgr - A pointer to the event processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int UnregisterSignalProcessor(CigiBaseSignalProcessing *SignalMgr);


   //=========================================================
   //! This places the specifed event method processor into
   //!   the unrecognized event processor list.
   //! \param EventMgr - A pointer to the event processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int RegisterUnrecognizedPacketEvent(CigiBaseEventProcessor *EventMgr)
   {
   	return(RegisterEventProcessor(0,EventMgr));
   }

   //=========================================================
   //! This removes the specifed Event method processor from
   //!   the unrecognized Event processor list.
   //! \param EventMgr - A pointer to the event processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int UnregisterUnrecognizedPacketEvent(CigiBaseEventProcessor *EventMgr)
   {
      return(UnregisterEventProcessor(0,EventMgr));
   }


   //=========================================================
   //! This places the specifed CallBack method processor into
   //!   the unrecognized CallBack processor list.
   //! \param CallBack - A pointer to the CallBack processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int RegisterUnrecognizedPacketCallBack(CigiCBProcessor CallBack)
   {
      return(RegisterCallBack(0,CallBack));
   }

   //=========================================================
   //! This removes the specifed CallBack method processor from
   //!   the unrecognized CallBack processor list.
   //! \param CallBack - A pointer to the CallBack processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int UnregisterUnrecognizedPacketCallBack(CigiCBProcessor CallBack)
   {
      return(UnregisterCallBack(0,CallBack));
   }

   //=========================================================
   //! This places the specifed Event method processor into
   //!   the unhandled Event processor list.
   //! \param EventMgr - A pointer to the event processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int RegisterUnhandledPacketEvent(CigiBaseEventProcessor *EventMgr)
   {
   	return(RegisterEventProcessor(256,EventMgr));
   }

   //=========================================================
   //! This removes the specifed signal method processor from
   //!   the signal processor list.
   //! \param EventMgr - A pointer to the event processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int UnregisterUnhandledPacketEvent(CigiBaseEventProcessor *EventMgr)
   {
      return(UnregisterEventProcessor(256,EventMgr));
   }


   //=========================================================
   //! This places the specifed CallBack method processor into
   //!   the unhandled callback processor list.
   //! \param CallBack - A pointer to the CallBack processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int RegisterUnhandledPacketCallBack(CigiCBProcessor CallBack)
   {
      return(RegisterCallBack(256,CallBack));
   }

   //=========================================================
   //! This removes the specifed CallBack method processor from
   //!   the unhandled callback processor list.
   //! \param CallBack - A pointer to the CallBack processor
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int UnregisterUnhandledPacketCallBack(CigiCBProcessor CallBack)
   {
      return(UnregisterCallBack(256,CallBack));
   }


   //==> Buffer Packing Managers


   //=========================================================
   //! Gets a pointer to the next Message buffer to be used to
   //!   input a message.
   //! \return This returns a pointer to the next Message buffer.
   //!
   Cigi_uint8 *GetNextBuffToLoad(void);

   //=========================================================
   //! Advances the message buffer index to the next Message buffer
   //!   to be used to process a message.
   //!
   void AdvanceCrntBuffer(void);

   //=========================================================
   //! Sets the size of the message in the Current fill buffer.
   //! \param MsgSize - the size (in bytes) of the message just 
   //!   placed into the current message fill buffer.
   //!
   void SetCrntMsgSize(int MsgSize)
   {
      if(CrntMsgBuf != NULL)
         CrntMsgBuf->BufferFillCnt = MsgSize;
   }



   //==> Accessing Member Variable Values functions

   //=========================================================
   //! Gets a pointer to the current Message buffer.
   //! \return the pointer to the Message buffer
   //!
   Cigi_uint8 * GetMsgBuffer()
   {
      if(CrntMsgBuf == NULL)
         AdvanceCrntBuffer();

      return(CrntMsgBuf->Buffer);
   }

   //=========================================================
   //! Sets the size of the message in the Current fill buffer.
   //! \return This returns the message buffer size
   //!
   int GetMsgBufSize(void) { return(CrntMsgBuf->BufferSize); }


   //+> Iteration Method Flag

   //=========================================================
   //! Sets the flag specifying whether the Iteration method is being used.
   //! \param IterationIn - Iteration method flag.<br>
   //!  true - The Iteration method is being used.<br>
   //!  false - The Callback, Event, (and/or) Signal method(s) 
   //!    (is/are) used.
   //!
   void UsingIteration(bool IterationIn=true) { Iteration = IterationIn; }

   //=========================================================
   //! Gets the flag specifying whether the Iteration method is being used.
   //! \return - Iteration method flag.<br>
   //!  true - The Iteration method is being used.<br>
   //!  false - The Callback, Event, (and/or) Signal method(s) 
   //!    (is/are) used.
   //!
   bool CheckIteration(void) { return(Iteration); }


   //+> Reader's CIGI Version

   //=========================================================
   //! This allows the user to specify the version of CIGI
   //!   that the reader software uses.  This is needed to
   //!   do version conversion processing.  It also adjusts the
   //!   signal tables.
   //! \param Version - the version of CIGI that the reader
   //!   software uses.
   //!
	void SetReaderVersion(CigiVersionID &Version);

   //=========================================================
   //! Sets the CIGI version that the reader is using.
   //! \param CigiVersionIn - The CIGI version to which the application
   //!   is coded.<br>
   //! \param bndchk - Enables (true) or disables (false) bounds checking
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int SetReaderCigiVersion(const int CigiVersionIn, bool bndchk=true)
   {
      CigiVersionID tVer(CigiVersionIn,0);
      SetReaderVersion(tVer);
      return(CIGI_SUCCESS);
   }

   //=========================================================
   //! Sets the CIGI version that the reader is using.
   //! \param CigiVersionIn - The CIGI version to which the application
   //!   is coded.<br>
   //! \param CigiMinorVersionIn - The CIGI minor version to which the application
   //!   is coded.<br>
   //! \param bndchk - Enables (true) or disables (false) bounds checking
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int SetReaderCigiVersion(const int CigiVersionIn, const int CigiMinorVersionIn, bool bndchk=true)
   {
      CigiVersionID tVer(CigiVersionIn,CigiMinorVersionIn);
      SetReaderVersion(tVer);
      return(CIGI_SUCCESS);
   }

   //=========================================================
   //! Gets the CIGI version that the reader is using.
   //! \return The CIGI version that the Reader is using.
   //!
   int GetReaderCigiVersion(void) const
   {
      return(ReaderVersion.CigiMajorVersion);
   }

   //=========================================================
   //! Gets the Reader's Cigi Minor Version.
   //! \return the Cigi Minor Version of the reader and processing routines.
   //!
   int GetReaderCigiMinorVersion(void) const { return(ReaderVersion.CigiMinorVersion); }


   //+> Registering

   //=========================================================
   //! Register a user packet for use.
   //! \param Packet - A pointer to the packet manager object
   //! \param PacketID - The packet id
   //! \param HostSend - A flag specifying whether the host
   //!   can send this packet.
   //! \param IGSend - A flag specifying whether the IG
   //!   can send this packet.
   //!
   //! \return the a flag specifying whether the specified
   //!   packet is valid to send.
   //!
	int RegisterUserPacket(CigiBasePacket *Packet,
                          Cigi_uint8 PacketID,
                          bool HostSend,
                          bool IGSend);



protected:

   //==> Member variables

   //=========================================================
   //! Iteration<br>
   //! Specifies whether the Iteration method is being used<br>
   //!  true - The Iteration method is being used.<br>
   //!  false - The Callback, Event, (and/or) Signal method(s) 
   //!    (is/are) used.
   //!
   bool Iteration;

   //=========================================================
   //! CrntPacket<br>
   //! A pointer to the first byte of the current packet.
   //!
   Cigi_uint8 *CrntPacket;

   //=========================================================
   //! ReadBufferPos<br>
   //! An index into the message buffer specifying where the
   //!   the next byte to be read is.
   //!
   int ReadBufferPos;

   //=========================================================
   //! EventList<br>
   //! The table of Event lists.
   //!
   list<CigiBaseEventProcessor *>EventList[257];

   //=========================================================
   //! CallBackList<br>
   //! The table of Callback lists.
   //!
   list<CigiCBProcessor>CallBackList[257];

   //=========================================================
   //! SignalList<br>
   //! The beginning of the Signal list.
   //!
   list<CigiBaseSignalProcessing *>SignalList;

   //=========================================================
   //! Swap<br>
   //! Specifies when the message must be byte swapped.
   //!
   bool Swap;

   //=========================================================
   //! MostMatureCigiVersionReceived<br>
   //! Specifies the most mature (i.e. newest version) of CIGI received.
   //!
   CigiVersionID MostMatureCigiVersionReceived;

   //=========================================================
   //! ProcessingVersion<br>
   //! Specifies the current version of CIGI being used for iteration.
   //!
   CigiVersionID ProcessingVersion;

   //=========================================================
   //! ReaderVersion<br>
   //! Specifies the current version of CIGI being used by
   //!   the reader.
   //!
   CigiVersionID ReaderVersion;

   //=========================================================
   //! The Conversion Table for managers of incoming packets
   //!
   CigiBasePacket *IncomingHandlerTbl[256];

   //=========================================================
   //! The Table containing the Signal Type of the packet
   //!  for managers of incoming packets.
   //!
   CigiSignalType::Type SignalTbl[256];

   //=========================================================
   //! A pointer to the default packet used to unpack
   //!  un recognized packets.
   //!
   CigiDefaultPacket *DefaultPckt;


   //==> Member protected functions

   //=========================================================
   //! This takes the packet id and determines which signal method
   //!   to call.  It then goes through the signal list and calls
   //!   the correct signal method in each of the signal objects.
   //! \param PacketID - The Packet ID of the message to be processed.
   //! \param Packet - A pointer to the packet object that has
   //!    parsed the current message packet.
   //!
   bool SignalJump(const Cigi_uint8 PacketID, CigiBasePacket *Packet);

   //=========================================================
   //! Clear the Processing Table
   //! \param Complete - If true - the entire table is cleared.
   //!    if false - the table is cleared except for the user
   //!    defined section.
   //!
	void ClearTbls(bool Complete);

   //=========================================================
   //! Sets the external interface tables to Host output with
   //!   Cigi Version 1 packets
   //!
	void SetIncomingHostV1Tbls(void);

   //=========================================================
   //! Sets the external interface tables to IG output with
   //!   Cigi Version 1 packets
   //!
	void SetIncomingIGV1Tbls(void);

   //=========================================================
   //! Sets the external interface tables to Host output with
   //!   Cigi Version 2 packets
   //!
	void SetIncomingHostV2Tbls(void);

   //=========================================================
   //! Sets the external interface tables to IG output with
   //!   Cigi Version 2 packets
   //!
	void SetIncomingIGV2Tbls(void);

   //=========================================================
   //! Sets the external interface tables to Host output with
   //!   Cigi Version 3 packets
   //!
	void SetIncomingHostV3Tbls(void);

   //=========================================================
   //! Sets the external interface tables to IG output with
   //!   Cigi Version 3 packets
   //!
	void SetIncomingIGV3Tbls(void);

   //=========================================================
   //! Sets the external interface tables to IG output with
   //!   Cigi Version 3 packets
   //!
	int CheckFirstPacket(Cigi_uint8 *Buff);


};

#endif // !defined(_CIGI_INCOMING_MESSAGE_INCLUDED_)