WDL/projectcontext.h

   1 #ifndef _PROJECTCONTEXT_H_
   2 #define _PROJECTCONTEXT_H_
   3
   4 #include "wdltypes.h"
   5
   6 class WDL_FastString;
   7 class WDL_HeapBuf;
   8 class WDL_FastQueue;
   9
  10 #ifndef _REAPER_PLUGIN_PROJECTSTATECONTEXT_DEFINED_
  11 #define _WDL_PROJECTSTATECONTEXT_DEFINED_
  12
  13 class ProjectStateContext // this is also defined in reaper_plugin.h (keep them identical, thx)
  14 {
  15 public:
  16   virtual ~ProjectStateContext(){};
  17
  18   virtual void WDL_VARARG_WARN(printf,2,3) AddLine(const char *fmt, ...) = 0;
  19   virtual int GetLine(char *buf, int buflen)=0; // returns -1 on eof
  20
  21   virtual WDL_INT64 GetOutputSize()=0;
  22
  23   virtual int GetTempFlag()=0;
  24   virtual void SetTempFlag(int flag)=0;
  25 };
  26
  27 #endif
  28
  29 ProjectStateContext *ProjectCreateFileRead(const char *fn);
  30 ProjectStateContext *ProjectCreateFileWrite(const char *fn);
  31 ProjectStateContext *ProjectCreateMemCtx(WDL_HeapBuf *hb); // read or write (ugh, deprecated), be sure to delete it before accessing hb
  32 ProjectStateContext *ProjectCreateMemCtx_Read(const WDL_HeapBuf *hb); // read only
  33 ProjectStateContext *ProjectCreateMemCtx_Write(WDL_HeapBuf *hb); // write only, be sure to delete it before accessing hb
  34 ProjectStateContext *ProjectCreateMemWriteFastQueue(WDL_FastQueue *fq); // only write! no need to do anything at all before accessing (can clear/reuse as necessary)
  35
  36
  37 // helper functions
  38 class LineParser;
  39 bool ProjectContext_EatCurrentBlock(ProjectStateContext *ctx,
  40                                     ProjectStateContext *ctxOut=NULL); // returns TRUE if got valid >, otherwise it means eof...
  41                                                                        // writes to ctxOut if specified, will not write final >
  42
  43 bool ProjectContext_GetNextLine(ProjectStateContext *ctx, LineParser *lpOut); // true if lpOut is valid
  44
  45 char *projectcontext_fastDoubleToString(double value, char *bufOut, int prec_digits); // returns pointer to end of encoded string. prec_digits 0..18.
  46 int ProjectContextFormatString(char *outbuf, size_t outbuf_size, const char *fmt, va_list va); // returns bytes used
  47
  48 int cfg_decode_binary(ProjectStateContext *ctx, WDL_HeapBuf *hb); // 0 on success, doesnt clear hb
  49 void cfg_encode_binary(ProjectStateContext *ctx, const void *ptr, int len);
  50
  51 int cfg_decode_textblock(ProjectStateContext *ctx, WDL_FastString *str); // 0 on success, appends to str
  52 void cfg_encode_textblock(ProjectStateContext *ctx, const char *text); // long lines get split by newlines
  53 void cfg_encode_textblock2(ProjectStateContext *ctx, const char *text); // preserves newlines/long lines/etc (requires recent cfg_decode_textblock())
  54
  55 char getConfigStringQuoteChar(const char *in, bool prefer_quoteless=true); // returns 0 if no quote char available!
  56 bool configStringWantsBlockEncoding(const char *in); // returns true if over 1k long, has newlines, or contains all quote chars
  57 void makeEscapedConfigString(const char *in, WDL_FastString *out);
  58
  59
  60 class ProjectStateContext_GenericRead : public ProjectStateContext
  61 {
  62   protected:
  63    const char *m_ptr;
  64    const char *m_endptr;
  65    int m_tmpflag;
  66
  67   public:
  68     ProjectStateContext_GenericRead(const void *buf, int sz) : m_tmpflag(0)
  69     {
  70       m_ptr = (const char *)buf;
  71       m_endptr = m_ptr ? m_ptr+sz : NULL;
  72     }
  73     virtual ~ProjectStateContext_GenericRead() {}
  74
  75     virtual void WDL_VARARG_WARN(printf,2,3) AddLine(const char *fmt, ...) { }
  76     virtual int GetLine(char *buf, int buflen) // returns -1 on eof
  77     {
  78       const char *p = m_ptr;
  79       const char *ep = m_endptr;
  80
  81       while (p < ep && (!*p || *p == '\t' || *p == '\r' || *p == '\n' || *p == ' ')) p++;
  82       if (p >= ep)
  83       {
  84         m_ptr=p;
  85         return -1;
  86       }
  87
  88       if (buflen > 0)
  89       {
  90         while (--buflen > 0 && *p) *buf++ = *p++;
  91         *buf=0;
  92       }
  93
  94       while (*p) p++;
  95       m_ptr=p+1; // skip NUL
  96
  97       return 0;
  98     }
  99     virtual int GetTempFlag() { return m_tmpflag; }
 100     virtual void SetTempFlag(int flag) { m_tmpflag=flag; }
 101     virtual WDL_INT64 GetOutputSize() { return 0; }
 102 };
 103
 104
 105 #endif//_PROJECTCONTEXT_H_