Merge mysql.com:/home/kent/bk/tmp/mysql-4.1-build

\input texinfo  @c -*-texinfo-*-

@c

@c *********************************************************

@c

@c This is a dummy placeholder file for internals.texi in the

@c MySQL source trees.

@c

@c Note, that the internals documentation has been moved into a separate

@c BitKeeper source tree named "mysqldoc" - do not attempt to edit this

@c file! All changes to internals.texi should be done in the mysqldoc tree.

@c

@c See http://www.mysql.com/doc/en/Installing_source_tree.html

@c for information about how to work with BitKeeper source trees.

@c

@c This dummy file is being replaced with the actual file from the

@c mysqldoc tree when building the official source distribution.

@c

@c Please e-mail docs@mysql.com for more information or if

@c you are interested in doing a translation.

@c

@c *********************************************************

@c

@c %**start of header

@setfilename internals.info

@c We want the types in the same index

@syncodeindex tp fn

@ifclear tex-debug

@c This removes the black squares in the right margin

@finalout

@end ifclear

@c Set background for HTML

@set _body_tags BGCOLOR=silver TEXT=#000000 LINK=#101090 VLINK=#7030B0

@c Set some style elements for the manual in HTML form. 'suggested'

@c natural language colors: aqua, black, blue, fuchsia, gray, green,

@c lime, maroon, navy, olive, purple, red, silver, teal, white, and

@c yellow. From Steeve Buehler <ahr@YogElements.com>

@set _extra_head <style> code {color:purple} tt {color:green} samp {color:navy} pre {color:maroon} </style>

@settitle Dummy MySQL internals documentation for version @value{mysql_version}.

@c We want single-sided heading format, with chapters on new pages. To

@c get double-sided format change 'on' below to 'odd'

@setchapternewpage on

@paragraphindent 0

@c %**end of header

@ifinfo

@format

START-INFO-DIR-ENTRY

* mysql: (mysql).               MySQL documentation.

END-INFO-DIR-ENTRY

@end format

@end ifinfo

@titlepage

@sp 10

@center @titlefont{Empty placeholder for the MySQL Internals Documentation}

@sp 10

@center Copyright @copyright{} 1995-2003 MySQL AB

@c blank page after title page makes page 1 be a page front.

@c also makes the back of the title page blank.

@page

@end titlepage

@c This should be added. The HTML conversion also needs a MySQL version

@c number somewhere.

@iftex

@c change this to double if you want formatting for double-sided

@c printing

@headings single

@oddheading @thischapter @| @| @thispage

@evenheading @thispage @| @| MySQL Internal Reference for Version @value{mysql_version}

@end iftex

@node Top, (dir), (dir), (dir)

@ifinfo

This is an empty placeholder file for the MySQL internals documentation.

The real version of this file is now maintained in a separate BitKeeper

source tree!  Please see

@url{http://www.mysql.com/doc/en/Installing_source_tree.html} for more info

on how to work with BitKeeper.

Please do not attempt to edit this file directly - use the one in the

@code{mysqldoc} BK tree instead.

This file will be replaced with the current @code{internals.texi} when

building the official source distribution.

@end ifinfo

@bye

#!@PERL@

# Copyright (C) 2003 MySQL AB

# 

# This program 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; version 2 of the License.

# 

# This program 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 this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

#

# fill_func_tables - parse ../Docs/manual.texi 

#

# Original version by Victor Vagin <vva@mysql.com>

#

my $cat_name= "";

my $func_name= "";

my $text= "";

my $example= "";

local $mode= "";

sub prepare_name

{

  my ($a)= @_;

  $a =~ s/(\@itemize \@bullet)/  /g;

  $a =~ s/(\@end itemize)/  /g;

  $a =~ s/(\@end multitable)/  /g;

  $a =~ s/(\@end table)/  /g;

  $a =~ s/(\@cindex(.*?)\n)/  /g;

  $a =~ s/(\@multitable \@columnfractions(.*?)\n)/  /g;

  $a =~ s/(\@node(.*?)\n)/  /g;

  $a =~ s/(\@tab)/\t/g;

  $a =~ s/\@item/  /g;

  $a =~ s/\@code\{((.|\n)+?)\}/$1/go;

  $a =~ s/\@strong\{(.+?)\}/$1/go;

  $a =~ s/\@samp\{(.+?)\}/$1/go;

  $a =~ s/\@emph\{((.|\n)+?)\}/\/$1\//go;

  $a =~ s/\@xref\{((.|\n)+?)\}/See also : [$1]/go;

  $a =~ s/\@ref\{((.|\n)+?)\}/[$1]/go;

  $a =~ s/\'/\'\'/g;

  $a =~ s/\\/\\\\/g;

  $a =~ s/\`/\`\`/g;

  $a =~ s/\@table \@code/  /g;

  $a =~ s/\(\)//g;

  $a =~ s/((\w|\s)+)\(([\+-=><\/%*!<>\s]+)\)/$3/gxs; #$a =~ s/((\w|\s)+)\(([\+-=><\/%*!<>\s]+)\)/$3 $1/gxs;

  $a =~ s/([\+-=><\/%*!<>\s]+)\(((\w|\s)+)\)/$1/gxs;#$a =~ s/([\+-=><\/%*!<>\s]+)\(((\w|\s)+)\)/$1 $2/gxs;

  $a =~ s/((\w|\s)+)\((.+)\)/$1/gxs;

  return $a;

}

sub prepare_text

{

  my ($a)= @_;

  $a =~ s/(\@itemize \@bullet)/  /g;

  $a =~ s/(\@end itemize)/  /g;

  $a =~ s/(\@end multitable)/  /g;

  $a =~ s/(\@end table)/  /g;

  $a =~ s/(\@cindex(.*?)\n)/  /g;

  $a =~ s/(\@multitable \@columnfractions(.*?)\n)/  /g;

  $a =~ s/(\@node(.*?)\n)/  /g;

  $a =~ s/(\@tab)/\t/g;

  $a =~ s/\@itemx/  /g;

  $a =~ s/\@item/  /g;

  $a =~ s/\@code\{((.|\n)+?)\}/$1/go;

  $a =~ s/\@strong\{(.+?)\}/$1/go;

  $a =~ s/\@samp\{(.+?)\}/$1/go;

  $a =~ s/\@emph\{((.|\n)+?)\}/\/$1\//go;

  $a =~ s/\@xref\{((.|\n)+?)\}/See also : [$1]/go;

  $a =~ s/\@ref\{((.|\n)+?)\}/[$1]/go;

  $a =~ s/\'/\'\'/g;

  $a =~ s/\\/\\\\/g;

  $a =~ s/\`/\`\`/g;

  $a =~ s/(\n*?)$//g;

  $a =~ s/\n/\\n/g;

  $a =~ s/\@table \@code/  /g;

  return $a;

}

sub prepare_example

{

  my ($a)= @_;

  $a =~ s/\'/\'\'/g;

  $a =~ s/\\/\\\\/g;

  $a =~ s/\`/\`\`/g;

  $a =~ s/(\n*?)$//g;

  $a =~ s/\n/\\n/g;

  return $a;

}

sub flush_all

{

  my ($mode) = @_;

  if ($mode eq ""){return;}

  $func_name= prepare_name($func_name);

  $text= prepare_text($text);

  $example= prepare_example($example);

  if ($func_name ne "" && $text ne "" && !($func_name =~ /[abcdefghikjlmnopqrstuvwxyz]/)){

    print "INSERT INTO function (name,description,example) VALUES (";

    print "'$func_name',";

    print "'$text',";

    print "'$example'";

    print ");\n";

    print "INSERT INTO function_category (cat_id,func_id) VALUES (\@cur_category,LAST_INSERT_ID());\n";

  }

  $func_name= "";

  $text= "";

  $example= "";

  $mode= "";

}

sub new_category

{

  my ($category)= @_;

  $category= prepare_text($category);

  print "INSERT INTO function_category_name (name) VALUES (\'$category\');\n";

  print "SELECT \@cur_category:=LAST_INSERT_ID();\n";

}

print "INSERT INTO db (Host,DB,User,Select_priv) VALUES ('%','mysql_help','','Y');\n";

print "CREATE DATABASE mysql_help;\n";

print "USE mysql_help;\n";

print "DROP TABLE IF EXISTS function;\n";

print "CREATE TABLE function (";

print "  func_id       int unsigned not null auto_increment,";

print "  name          char(64) not null,";

print "  url           char(128) not null,";

print "  description   text not null,";

print "  example       text not null,";

print "  min_args      tinyint not null,";

print "  max_args      tinyint,";

print "  date_created  datetime not null,";

print "  last_modified timestamp not null,";

print "  primary key   (func_id)";

print ") type=myisam;\n\n";

print "DROP TABLE IF EXISTS function_category_name;\n";

print "CREATE TABLE function_category_name (";

print "  cat_id        smallint unsigned not null auto_increment,";

print "  name          char(64) not null,";

print "  url           char(128) not null,";

print "  date_created  datetime not null,";

print "  last_modified timestamp not null,";

print "  primary key   (cat_id)";

print ") type=myisam;\n\n";

print "DROP TABLE IF EXISTS function_category;\n";

print "CREATE TABLE function_category (";

print "  cat_id        smallint unsigned not null references function_category_name,";

print "  func_id       int unsigned not null references function,";

print "  primary key   (cat_id, func_id)";

print ") type=myisam;\n\n";

print "DELETE FROM function_category_name;\n";

print "DELETE FROM function_category;\n";

print "DELETE FROM function;\n";

print "SELECT \@cur_category:=null;\n\n";

my $in_section_6_3= 0;

for(<>)

{

  if ($_=~/\@section Functions for Use in \@code{SELECT} and \@code{WHERE} Clauses/ &&

      !$in_section_6_3){

    $in_section_6_3= 1;

    next;

  }

  if ($_=~/\@section/ && $in_section_6_3){

    $in_section_6_3= 0;

    next;

  }

  if (!$in_section_6_3) { next; }

  my $c_name= "";

  ($c_name)=m|\@c for_mysql_help,(.+?)$|;

  if (!($c_name eq "") && ! ($c_name =~ m/$cat_name/i)){

    ($cat_name)= $c_name;

    new_category($cat_name);

    next;

  }

  ($c_name)=m|\@subsubsection (.+?)$|;

  if (!($c_name eq "") && ! ($c_name =~ m/$cat_name/i)){

    ($cat_name)= $c_name;

    new_category($cat_name);

    next;

  }

  ($c_name)=m|\@subsection (.+?)$|;

  if (!($c_name eq "") && ! ($c_name =~ m/$cat_name/i)){

    ($cat_name)= $c_name;

    new_category($cat_name);

    next;

  }

  ($f_name)=m|\@findex (.+?)$|;

  if (!($f_name eq "")){

    flush_all($mode);

    ($func_name)= ($f_name);

    $mode= "text";

    next;

  }

  if ($_=~/\@example/ && ($mode eq "text")){

    $mode= "example";

    next;

  }

  if ($_=~/\@end example/ && ($mode eq "example")){

    flush_all($mode);

    next;

  }

  if ($mode eq "text")    { $text    .= $_; }

  if ($mode eq "example") { $example .= $_; }

}

print "DELETE function_category_name ";

print "FROM function_category_name ";

print "LEFT JOIN function_category ON function_category.cat_id=function_category_name.cat_id ";

print "WHERE function_category.cat_id is null;"