view modules/base64/base64.c @ 5146:88bd4f3ef8e4

make lrecord UID's have a separate UID space for each object, resurrect debug SOE code in extents.c -------------------- ChangeLog entries follow: -------------------- src/ChangeLog addition: 2010-03-15 Ben Wing <ben@xemacs.org> * alloc.c: * alloc.c (c_readonly): * alloc.c (deadbeef_memory): * alloc.c (make_compiled_function): * alloc.c (make_button_data): * alloc.c (make_motion_data): * alloc.c (make_process_data): * alloc.c (make_timeout_data): * alloc.c (make_magic_data): * alloc.c (make_magic_eval_data): * alloc.c (make_eval_data): * alloc.c (make_misc_user_data): * alloc.c (noseeum_make_marker): * alloc.c (ADDITIONAL_FREE_string): * alloc.c (common_init_alloc_early): * alloc.c (init_alloc_once_early): * bytecode.c (print_compiled_function): * bytecode.c (mark_compiled_function): * casetab.c: * casetab.c (print_case_table): * console.c: * console.c (print_console): * database.c (print_database): * database.c (finalize_database): * device-msw.c (sync_printer_with_devmode): * device-msw.c (print_devmode): * device-msw.c (finalize_devmode): * device.c: * device.c (print_device): * elhash.c: * elhash.c (print_hash_table): * eval.c (print_multiple_value): * eval.c (mark_multiple_value): * events.c (deinitialize_event): * events.c (print_event): * events.c (event_equal): * extents.c: * extents.c (soe_dump): * extents.c (soe_insert): * extents.c (soe_delete): * extents.c (soe_move): * extents.c (extent_fragment_update): * extents.c (print_extent_1): * extents.c (print_extent): * extents.c (vars_of_extents): * frame.c: * frame.c (print_frame): * free-hook.c: * free-hook.c (check_free): * glyphs.c: * glyphs.c (print_image_instance): * glyphs.c (print_glyph): * gui.c: * gui.c (copy_gui_item): * hash.c: * hash.c (NULL_ENTRY): * hash.c (KEYS_DIFFER_P): * keymap.c (print_keymap): * keymap.c (MARKED_SLOT): * lisp.h: * lrecord.h: * lrecord.h (LISP_OBJECT_UID): * lrecord.h (set_lheader_implementation): * lrecord.h (struct old_lcrecord_header): * lstream.c (print_lstream): * lstream.c (finalize_lstream): * marker.c (print_marker): * marker.c (marker_equal): * mc-alloc.c (visit_all_used_page_headers): * mule-charset.c: * mule-charset.c (print_charset): * objects.c (print_color_instance): * objects.c (print_font_instance): * objects.c (finalize_font_instance): * opaque.c (print_opaque): * opaque.c (print_opaque_ptr): * opaque.c (equal_opaque_ptr): * print.c (internal_object_printer): * print.c (enum printing_badness): * rangetab.c (print_range_table): * rangetab.c (range_table_equal): * specifier.c (print_specifier): * specifier.c (finalize_specifier): * symbols.c: * symbols.c (print_symbol_value_magic): * tooltalk.c: * tooltalk.c (print_tooltalk_message): * tooltalk.c (print_tooltalk_pattern): * window.c (print_window): * window.c (debug_print_window): (1) Make lrecord UID's have a separate UID space for each object. Otherwise, with 20-bit UID's, we rapidly wrap around, especially when common objects like conses and strings increment the UID value for every object created. (Originally I tried making two UID spaces, one for objects that always print readably and hence don't display the UID, and one for other objects. But certain objects like markers for which a UID is displayed are still generated rapidly enough that UID overflow is a serious issue.) This also has the advantage of making UID values smaller, hence easier to remember -- their main purpose is to make it easier to keep track of different objects of the same type when debugging code. Make sure we dump lrecord UID's so that we don't have problems with pdumped and non-dumped objects having the same UID. (2) Display UID's consistently whenever an object (a) doesn't consistently print readably (objects like cons and string, which always print readably, can't display a UID), and (b) doesn't otherwise have a unique property that makes objects of a particular type distinguishable. (E.g. buffers didn't and still don't print an ID, but the buffer name uniquely identifies the buffer.) Some types, such as event, extent, compiled-function, didn't always (or didn't ever) display an ID; others (such as marker, extent, lstream, opaque, opaque-ptr, any object using internal_object_printer()) used to display the actual machine pointer instead. (3) Rename NORMAL_LISP_OBJECT_UID to LISP_OBJECT_UID; make it work over all Lisp objects and take a Lisp object, not a struct pointer. (4) Some misc cleanups in alloc.c, elhash.c. (5) Change code in events.c that "deinitializes" an event so that it doesn't increment the event UID counter in the process. Also use deadbeef_memory() to overwrite memory instead of doing the same with custom code. In the process, make deadbeef_memory() in alloc.c always available, and delete extraneous copy in mc-alloc.c. Also capitalize all uses of 0xDEADBEEF. Similarly in elhash.c call deadbeef_memory(). (6) Resurrect "debug SOE" code in extents.c. Make it conditional on DEBUG_XEMACS and on a `debug-soe' variable, rather than on SOE_DEBUG. Make it output to stderr, not stdout. (7) Delete some custom print methods that were identical to external_object_printer().
author Ben Wing <ben@xemacs.org>
date Mon, 15 Mar 2010 16:35:38 -0500
parents 0ac12485616c
children 308d34e9f07d
line wrap: on
line source

/* base64 interface for XEmacs.
   Copyright (C) 1998, 1999 Free Software Foundation, Inc.
   Copyright (C) 2010 Ben Wing.

This file is part of XEmacs.

XEmacs 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 2, or (at your option) any
later version.

XEmacs 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 XEmacs; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */

/* Synched up with: Not in FSF. */

/* Author: William Perry <wmperry@aventail.com> */

#include <emodules.h>

unsigned char alphabet[64] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";

DEFUN ("base64-encode", Fbase64_encode, 1, 5, 0, /*
Return the base64 encoding of an object.
OBJECT is either a string or a buffer.
Optional arguments START and END denote buffer positions for computing the
hash of a portion of OBJECT.  The optional CODING argument specifies the coding
system the text is to be represented in while computing the digest.  This only
has meaning with MULE, and defaults to the current format of the data.
If ERROR-ME-NOT is nil, report an error if the coding system can't be
determined.  Else assume binary coding if all else fails.
*/
       (object, start, end, coding, error_me_not))
{
  int cols,bits,char_count;
  Lisp_Object instream, outstream,deststream;
  Lstream *istr, *ostr, *dstr;
  static Extbyte_dynarr *conversion_out_dynarr;
  static Extbyte_dynarr *out_dynarr;
  char tempbuf[1024]; /* some random amount */
  struct gcpro gcpro1, gcpro2;
  Lisp_Object conv_out_stream, coding_system;
  Lstream *costr;
  struct gcpro gcpro3;

  if (!conversion_out_dynarr)
    conversion_out_dynarr = Dynarr_new (Extbyte);
  else
    Dynarr_reset (conversion_out_dynarr);

  if (!out_dynarr)
    out_dynarr = Dynarr_new (Extbyte);
  else
    Dynarr_reset (out_dynarr);

  char_count = bits = cols = 0;

  /* set up the in stream */
  if (BUFFERP (object))
    {
      struct buffer *b = XBUFFER (object);
      Charbpos begv, endv;
      /* Figure out where we need to get info from */
      get_buffer_range_char (b, start, end, &begv, &endv, GB_ALLOW_NIL);

      instream = make_lisp_buffer_input_stream (b, begv, endv, 0);
    }
  else
    {
      Bytecount bstart, bend;
      CHECK_STRING (object);
      get_string_range_byte (object, start, end, &bstart, &bend,
			     GB_HISTORICAL_STRING_BEHAVIOR);
      instream = make_lisp_string_input_stream (object, bstart, bend);
    }
  istr = XLSTREAM (instream);

  /* Find out what format the buffer will be saved in, so we can make
     the digest based on what it will look like on disk */
  if (NILP (coding))
    {
      if (BUFFERP (object)) 
	{
	  /* Use the file coding for this buffer by default */
	  coding_system = XBUFFER (object)->buffer_file_coding_system;
	}
      else
	{
	  /* attempt to autodetect the coding of the string.  Note: this VERY hit-and-miss */
	  enum eol_type eol = EOL_AUTODETECT;
	  coding_system = Fget_coding_system (Qundecided);
	  determine_real_coding_system (istr, &coding_system, &eol);
	}
      if (NILP (coding_system)) 
	coding_system = Fget_coding_system (Qbinary);
      else
	{
	  coding_system = Ffind_coding_system (coding_system);
	  if (NILP (coding_system))
	    coding_system = Fget_coding_system (Qbinary);
	}
    }
  else
    {
      coding_system = Ffind_coding_system (coding);
      if (NILP (coding_system))
	{
	  if (NILP (error_me_not))
	    signal_simple_error ("No such coding system", coding);
	  else
	    coding_system = Fget_coding_system (Qbinary); /* default to binary */
	}
    }

  /* setup the out stream */
  outstream = make_dynarr_output_stream ((unsigned_char_dynarr *)conversion_out_dynarr);
  ostr = XLSTREAM (outstream);
  deststream = make_dynarr_output_stream ((unsigned_char_dynarr *)out_dynarr);
  dstr = XLSTREAM (deststream);
  /* setup the conversion stream */
  conv_out_stream = make_encoding_output_stream (ostr, coding_system);
  costr = XLSTREAM (conv_out_stream);
  GCPRO3 (instream, outstream, conv_out_stream);

  /* Get the data while doing the conversion */
  while (1)
    {
      int size_in_bytes = Lstream_read (istr, tempbuf, sizeof (tempbuf));
      int l;
      if (!size_in_bytes)
	break;
      /* It does seem the flushes are necessary... */
      Lstream_write (costr, tempbuf, size_in_bytes);
      Lstream_flush (costr);
      Lstream_flush (ostr);

      /* Update the base64 output buffer */
      for (l = 0; l < size_in_bytes; l++)
	{
	  bits += Dynarr_at (conversion_out_dynarr,l);
	  char_count++;
	  if (char_count == 3)
	    {
	      static char obuf[4];
	      obuf[0] = alphabet[(bits >> 18)];
	      obuf[1] = alphabet[(bits >> 12) & 0x3f];
	      obuf[2] = alphabet[(bits >>  6) & 0x3f];
	      obuf[3] = alphabet[bits & 0x3f];

	      Lstream_write (dstr,obuf,sizeof (obuf));
	      cols += 4;
	      if (cols == 72)
		{
		  Lstream_write (dstr,"\n",sizeof (unsigned char));
		  cols = 0;
		}
	      bits = char_count = 0;
	    }
	  else
	    {
	      bits <<= 8;
	    }
	}
      /* reset the dynarr */
      Lstream_rewind (ostr);
    }
  Lstream_close (istr);
  Lstream_close (costr);
  Lstream_close (ostr);

  if (char_count != 0)
    {
      bits <<= 16 - (8 * char_count);
      Lstream_write (dstr,&alphabet[bits >> 18],sizeof (unsigned char));
      Lstream_write (dstr,&alphabet[(bits >> 12) & 0x3f],sizeof (unsigned char));
      if (char_count == 1)
	{
	  Lstream_write (dstr,"==",2 * sizeof (unsigned char));
	} else
	{
	  Lstream_write (dstr,&alphabet[(bits >> 6) & 0x3f],sizeof (unsigned char));
	  Lstream_write (dstr,"=",sizeof (unsigned char));
	}
    }
#if 0
  if (cols > 0)
    {
      Lstream_write (dstr,"\n",sizeof (unsigned char));
    }
#endif
  UNGCPRO;
  Lstream_delete (istr);
  Lstream_delete (ostr);
  Lstream_delete (costr);
  Lstream_flush (dstr);
  Lstream_delete (dstr);

  return (make_string (Dynarr_atp (out_dynarr,0),Dynarr_length (out_dynarr)));
}

DEFUN ("base64-decode", Fbase64_decode, 1, 5, 0, /*
Undo the base64 encoding of an object.
OBJECT is either a string or a buffer.
Optional arguments START and END denote buffer positions for computing the
hash of a portion of OBJECT.  The optional CODING argument specifies the coding
system the text is to be represented in while computing the digest.  This only
has meaning with MULE, and defaults to the current format of the data.
If ERROR-ME-NOT is nil, report an error if the coding system can't be
determined.  Else assume binary coding if all else fails.
*/
       (object, start, end, coding, error_me_not))
{
  static char inalphabet[256], decoder[256];
  int i,cols,bits,char_count,hit_eof;
  Lisp_Object instream, outstream,deststream;
  Lstream *istr, *ostr, *dstr;
  static Extbyte_dynarr *conversion_out_dynarr;
  static Extbyte_dynarr *out_dynarr;
  char tempbuf[1024]; /* some random amount */
  struct gcpro gcpro1, gcpro2;
  Lisp_Object conv_out_stream, coding_system;
  Lstream *costr;
  struct gcpro gcpro3;

  for (i = (sizeof alphabet) - 1; i >= 0 ; i--)
    {
      inalphabet[alphabet[i]] = 1;
      decoder[alphabet[i]] = i;
    }

  if (!conversion_out_dynarr)
    conversion_out_dynarr = Dynarr_new (Extbyte);
  else
    Dynarr_reset (conversion_out_dynarr);

  if (!out_dynarr)
    out_dynarr = Dynarr_new (Extbyte);
  else
    Dynarr_reset (out_dynarr);

  char_count = bits = cols = hit_eof = 0;

  /* set up the in stream */
  if (BUFFERP (object))
    {
      struct buffer *b = XBUFFER (object);
      Charbpos begv, endv;
      /* Figure out where we need to get info from */
      get_buffer_range_char (b, start, end, &begv, &endv, GB_ALLOW_NIL);

      instream = make_lisp_buffer_input_stream (b, begv, endv, 0);
    }
  else
    {
      Bytecount bstart, bend;
      CHECK_STRING (object);
      get_string_range_byte (object, start, end, &bstart, &bend,
			     GB_HISTORICAL_STRING_BEHAVIOR);
      instream = make_lisp_string_input_stream (object, bstart, bend);
    }
  istr = XLSTREAM (instream);

  /* Find out what format the buffer will be saved in, so we can make
     the digest based on what it will look like on disk */
  if (NILP (coding))
    {
      if (BUFFERP (object)) 
	{
	  /* Use the file coding for this buffer by default */
	  coding_system = XBUFFER (object)->buffer_file_coding_system;
	}
      else
	{
	  /* attempt to autodetect the coding of the string.  Note: this VERY hit-and-miss */
	  enum eol_type eol = EOL_AUTODETECT;
	  coding_system = Fget_coding_system (Qundecided);
	  determine_real_coding_system (istr, &coding_system, &eol);
	}
      if (NILP (coding_system)) 
	coding_system = Fget_coding_system (Qbinary);
      else
	{
	  coding_system = Ffind_coding_system (coding_system);
	  if (NILP (coding_system))
	    coding_system = Fget_coding_system (Qbinary);
	}
    }
  else
    {
      coding_system = Ffind_coding_system (coding);
      if (NILP (coding_system))
	{
	  if (NILP (error_me_not))
	    signal_simple_error ("No such coding system", coding);
	  else
	    coding_system = Fget_coding_system (Qbinary); /* default to binary */
	}
    }

  /* setup the out stream */
  outstream = make_dynarr_output_stream ((unsigned_char_dynarr *)conversion_out_dynarr);
  ostr = XLSTREAM (outstream);
  deststream = make_dynarr_output_stream ((unsigned_char_dynarr *)out_dynarr);
  dstr = XLSTREAM (deststream);
  /* setup the conversion stream */
  conv_out_stream = make_encoding_output_stream (ostr, coding_system);
  costr = XLSTREAM (conv_out_stream);
  GCPRO3 (instream, outstream, conv_out_stream);

  /* Get the data while doing the conversion */
  while (1)
    {
      int size_in_bytes = Lstream_read (istr, tempbuf, sizeof (tempbuf));
      int l;
      if (!size_in_bytes)
	{
	  hit_eof = 1;
	  break;
	}
      /* It does seem the flushes are necessary... */
      Lstream_write (costr, tempbuf, size_in_bytes);
      Lstream_flush (costr);
      Lstream_flush (ostr);

      /* Update the base64 output buffer */
      for (l = 0; l < size_in_bytes; l++)
	{
	  if (Dynarr_at (conversion_out_dynarr,l) == '=')
	    goto decoder_out;
	  bits += decoder[Dynarr_at (conversion_out_dynarr,l)];
	  fprintf (stderr,"%d\n",bits);
	  char_count++;
	  if (char_count == 4)
	    {
	      static unsigned char obuf[3];
	      obuf[0] = (bits >> 16);
	      obuf[1] = (bits >> 8) & 0xff;
	      obuf[2] = (bits & 0xff);

	      Lstream_write (dstr,obuf,sizeof (obuf));
	      bits = char_count = 0;
	    }
	  else
	    {
	      bits <<= 6;
	    }
	}
      /* reset the dynarr */
      Lstream_rewind (ostr);
    }
 decoder_out:
  Lstream_close (istr);
  Lstream_close (costr);
  Lstream_close (ostr);

  if (hit_eof)
    {
      if (char_count)
	{
	  error_with_frob (object,"base64-decode failed: at least %d bits truncated",((4 - char_count) * 6));
	}
    }
  switch (char_count)
    {
    case 1:
      error_with_frob (object, "base64 encoding incomplete: at least 2 bits missing");
      break;
    case 2:
      char_count = bits >> 10;
      Lstream_write (dstr,&char_count,sizeof (char_count));
      break;
    case 3:
      {
	unsigned char buf[2];
	buf[0] = (bits >> 16);
	buf[1] = (bits >> 8) & 0xff;
	Lstream_write (dstr,buf,sizeof (buf));
	break;
      }
    }

  UNGCPRO;
  Lstream_delete (istr);
  Lstream_delete (ostr);
  Lstream_delete (costr);
  Lstream_flush (dstr);
  Lstream_delete (dstr);

  return (make_string (Dynarr_atp (out_dynarr,0),Dynarr_length (out_dynarr)));
}

void
syms_of_base64 (void)
{
  DEFSUBR (Fbase64_encode);
  DEFSUBR (Fbase64_decode);
}

void
vars_of_base64 (void)
{
  Fprovide (intern ("base64"));
}