{
    "content": [
        {
            "type": "text",
            "text": "# Font::TTF::Table (perldoc)\n\n## NAME\n\nFont::TTF::Table - Superclass for tables and used for tables we don't have a class for\n\n## DESCRIPTION\n\nLooks after the purely table aspects of a TTF table, such as whether the table has been read\nbefore, locating the file pointer, etc. Also copies tables from input to output.\n\n## Sections\n\n- **NAME**\n- **DESCRIPTION**\n- **INSTANCE VARIABLES**\n- **METHODS**\n- **BUGS**\n- **AUTHOR**\n- **LICENSING**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Font::TTF::Table",
        "section": "",
        "mode": "perldoc",
        "summary": "Font::TTF::Table - Superclass for tables and used for tables we don't have a class for",
        "synopsis": null,
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "INSTANCE VARIABLES",
                "lines": 32,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 67,
                "subsections": []
            },
            {
                "name": "BUGS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "LICENSING",
                "lines": 5,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Font::TTF::Table - Superclass for tables and used for tables we don't have a class for\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Looks after the purely table aspects of a TTF table, such as whether the table has been read\nbefore, locating the file pointer, etc. Also copies tables from input to output.\n",
                "subsections": []
            },
            "INSTANCE VARIABLES": {
                "content": "Instance variables start with a space\n\nread\nFlag which indicates that the table has already been read from file.\n\ndat Allows the creation of unspecific tables. Data is simply output to any font file being\ncreated.\n\nnocompress\nIf set, overrides the font default for WOFF table compression. Is a scalar integer\nspecifying a table size threshold below which this table will not be compressed. Set to -1\nto never compress; 0 to always compress.\n\nINFILE\nThe read file handle\n\nOFFSET\nLocation of the file in the input file\n\nLENGTH\nLength in the input directory\n\nZLENGTH\nCompressed length of the table if a WOFF font. 0 < ZLENGTH < LENGTH implies table is\ncompressed.\n\nCSUM\nChecksum read from the input file's directory\n\nPARENT\nThe Font::TTF::Font that table is part of\n",
                "subsections": []
            },
            "METHODS": {
                "content": "Font::TTF::Table->new(%parms)\nCreates a new table or subclass. Table instance variables are passed in at this point as an\nassociative array.\n\n$t->read\nReads the table from the input file. Acts as a superclass to all true tables. This method marks\nthe table as read and then just sets the input file pointer but does not read any data. If the\ntable has already been read, then returns \"undef\" else returns $self\n\nFor WOFF-compressed tables, the table is first decompressed and a replacement file handle is\ncreated for reading the decompressed data. In this case ORIGINALOFFSET will preserve the\noriginal value of OFFSET for applications that care.\n\n$t->readdat\nReads the table into the \"dat\" instance variable for those tables which don't know any better\n\n$t->out($fh)\nWrites out the table to the font file. If there is anything in the \"dat\" instance variable then\nthis is output, otherwise the data is copied from the input file to the output\n\n$t->outxml($context)\nOutputs this table in XML format. The table is first read (if not already read) and then if\nthere is no subclass, then the data is dumped as hex data\n\n$t->XMLelement\nOutput a particular element based on its contents.\n\n$t->XMLend($context, $tag, %attrs)\nHandles the default type of <data> for those tables which aren't subclassed\n\n$t->minsize()\nReturns the minimum size this table can be. If it is smaller than this, then the table must be\nbad and should be deleted or whatever.\n\n$t->dirty($val)\nThis sets the dirty flag to the given value or 1 if no given value. It returns the value of the\nflag\n\n$t->update\nEach table knows how to update itself. This consists of doing whatever work is required to\nensure that the memory version of the table is consistent and that other parameters in other\ntables have been updated accordingly. I.e. by the end of sending \"update\" to all the tables, the\nmemory version of the font should be entirely consistent.\n\nSome tables which do no work indicate to themselves the need to update themselves by setting\nisDirty above 1. This method resets that accordingly.\n\n$t->empty\nClears a table of all data to the level of not having been read\n\n$t->release\nReleases ALL of the memory used by this table, and all of its component/child objects. This\nmethod is called automatically by 'Font::TTF::Font->release' (so you don't have to call it\nyourself).\n\nNOTE, that it is important that this method get called at some point prior to the actual\ndestruction of the object. Internally, we track things in a structure that can result in\ncircular references, and without calling '\"release()\"' these will not properly get cleaned up by\nPerl. Once this method has been called, though, don't expect to be able to do anything with the\n\"Font::TTF::Table\" object; it'll have no internal state whatsoever.\n\nDeveloper note: As part of the brute-force cleanup done here, this method will throw a warning\nmessage whenever unexpected key values are found within the \"Font::TTF::Table\" object. This is\ndone to help ensure that any unexpected and unfreed values are brought to your attention so that\nyou can bug us to keep the module updated properly; otherwise the potential for memory leaks due\nto dangling circular references will exist.\n",
                "subsections": []
            },
            "BUGS": {
                "content": "No known bugs\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Martin Hosken <http://scripts.sil.org/FontUtils>.\n",
                "subsections": []
            },
            "LICENSING": {
                "content": "Copyright (c) 1998-2016, SIL International (http://www.sil.org)\n\nThis module is released under the terms of the Artistic License 2.0. For details, see the full\ntext of the license in the file LICENSE.\n",
                "subsections": []
            }
        }
    }
}