evennia/src/utils/mudtable.py

# -*- coding: utf-8 -*-
"""

Mudtable

This is an advanced ASCII table creator. It was inspired
by prettytable but shares no code.


Example usage:

    table = Table("Heading1", "Heading2", table=[[1,2,3],[4,5,6],[7,8,9]], border="cells")
    table.add_column("This is long data", "This is even longer data")
    table.add_row("This is a single row")
    print table

Result:

+----------------------+----------+---+--------------------------+
|       Heading1       | Heading2 |   |                          |
+======================+==========+===+==========================+
|           1          |     4    | 7 |     This is long data    |
+----------------------+----------+---+--------------------------+
|           2          |     5    | 8 | This is even longer data |
+----------------------+----------+---+--------------------------+
|           3          |     6    | 9 |                          |
+----------------------+----------+---+--------------------------+
| This is a single row |          |   |                          |
+----------------------+----------+---+--------------------------+

As seen, the table will automatically expand with empty cells to
make the table symmetric.

Tables can be restricted to a given width.
If we created the above table with the width=50 keyword to Table()
and then added the extra column and row, the result would be

+-----------+------------+-----------+-----------+
| Heading1  |  Heading2  |           |           |
+===========+============+===========+===========+
|     1     |      4     |     7     | This is   |
|           |            |           | long data |
+-----------+------------+-----------+-----------+
|           |            |           | This is   |
|     2     |      5     |     8     |   even    |
|           |            |           |  longer   |
|           |            |           |   data    |
+-----------+------------+-----------+-----------+
|     3     |      6     |     9     |           |
+-----------+------------+-----------+-----------+
| This is a |            |           |           |
|  single   |            |           |           |
|    row    |            |           |           |
+-----------+------------+-----------+-----------+

When adding new rows/columns their data can have its
own alignments (left/center/right, top/center/bottom).

Contrary to prettytable, Evtable does not allow
for importing from files.

It is intended to be used with ANSIString for supporting
ANSI-coloured string types.

"""
from textwrap import wrap
from copy import deepcopy

#from src.utils.ansi import ANSIString

def make_iter(obj):
    "Makes sure that the object is always iterable."
    return not hasattr(obj, '__iter__') and [obj] or obj


# Cell class (see further down for the EvTable itself)

class Cell(object):
    """
    Holds a data cell for the table. A cell has a certain
    width and height and contains one or more lines of
    data. It can shrink and resize as needed.
    """
    def __init__(self, data, **kwargs):
        """
        data - the un-padded data of the entry.
        kwargs:
            width - desired width of cell. It will pad
                    to this size.
            height - desired height of cell. it will pad
                    to this size
            pad_left - number of extra pad characters on the left
            pad_right - extra pad characters on the right
            pad_top - extra pad lines top (will pad with vpad_char)
            pad_bottom - extra pad lines bottom (will pad with vpad_char)
            pad_char - pad character to use both for extra horizontal
                      padding
            vpad_char - pad character to use for extra vertical padding
                       and for vertical fill (default " ")
            fill_char - character used for horizontal fill (default " ")
            vfill_char - character used for vertical fill (default " ")

            align - "l", "r" or  "c", default is centered
            valign - "t", "b" or "c", default is centered

            border_left - left border width
            border_right - right border width
            border_top - top border width
            border_bottom - bottom border width
            border_left_char - char used for left border
            border_right_char
            border_top_char
            border_bottom_char
            cornerchar - character used when two borders cross.
                          (default is "")
            corner_top_left - if this is given, it replaces the
                            cornerchar in the upper left
                            corner
            corner_top_right
            corner_bottom_left
            corner_bottom_right
        """

        self.pad_left = int(kwargs.get("pad_left", 1))
        self.pad_right = int(kwargs.get("pad_right", 1))
        self.pad_top = int( kwargs.get("pad_top", 0))
        self.pad_bottom = int(kwargs.get("pad_bottom", 0))

        # avoid multi-char pad_chars messing up counting
        pad_char = kwargs.get("pad_char", " ")
        self.pad_char = pad_char[0] if pad_char else " "
        vpad_char = kwargs.get("vpad_char", " ")
        self.vpad_char = vpad_char[0] if vpad_char else " "
        fill_char = kwargs.get("fill_char", " ")
        self.fill_char = fill_char[0] if fill_char else " "
        vfill_char = kwargs.get("vfill_char", " ")
        self.vfill_char = vfill_char[0] if vfill_char else " "

        # borders and corners
        self.border_left = kwargs.get("border_left", 0)
        self.border_right = kwargs.get("border_right", 0)
        self.border_top = kwargs.get("border_top", 0)
        self.border_bottom = kwargs.get("border_bottom", 0)
        self.border_left_char = kwargs.get("border_left_char", "|")
        self.border_right_char = kwargs.get("border_right_char", "|")
        self.border_top_char = kwargs.get("border_topchar", "-")
        self.border_bottom_char = kwargs.get("border_bottom_char", "-")

        self.corner = kwargs.get("corner", "+")
        self.corner_top_left = kwargs.get("corner_top_left", self.corner)
        self.corner_top_right = kwargs.get("corner_top_right", self.corner)
        self.corner_bottom_left = kwargs.get("corner_bottom_left", self.corner)
        self.corner_bottom_right = kwargs.get("corner_bottom_right", self.corner)

        # alignments
        self.align = kwargs.get("align", "c")
        self.valign = kwargs.get("valign", "c")

        self.data = self._split_lines(unicode(data))
        #self.data = self._split_lines(ANSIString(unicode(data)))
        self.raw_width = max(len(line) for line in self.data)
        self.raw_height = len(self.data)

        # width/height is given without left/right or top/bottom padding
        if "width" in kwargs:
            width = kwargs.pop("width")
            self.width = width - self.pad_left - self.pad_right - self.border_left - self.border_right
            if self.width <= 0:
                raise Exception("Cell width too small - no space for data.")
        else:
            self.width = self.raw_width
        if "height" in kwargs:
            height = kwargs.pop("height")
            self.height = height - self.pad_top - self.pad_bottom - self.border_top - self.border_bottom
            if self.height <= 0:
                raise Exception("Cell height too small - no space for data.")
        else:
            self.height = self.raw_height

        # prepare data
        self.formatted = self._reformat()

    def _reformat(self):
        "Apply formatting"
        return self._border(self._pad(self._valign(self._align(self._fit_width(self.data)))))

    def _split_lines(self, text):
        "Simply split by linebreak"
        return text.split("\n")

    def _fit_width(self, data):
        """
        Split too-long lines to fit the desired width of the Cell.
        Note that this also updates raw_width
        """
        width = self.width
        adjusted_data = []
        for line in data:
            if 0 < width < len(line):
                adjusted_data.extend(wrap(line, width=width, drop_whitespace=False))
            else:
                adjusted_data.append(line)
        return adjusted_data

    def _center(self, text, width, pad_char):
        "Horizontally center text on line of certain width, using padding"
        excess = width - len(text)
        if excess <= 0:
            return text
        if excess % 2:
            # uneven padding
            narrowside = (excess // 2) * pad_char
            widerside = narrowside + pad_char
            if width % 2:
                return narrowside + text + widerside
            else:
                return widerside + text + narrowside
        else:
            # even padding - same on both sides
            side = (excess // 2) * pad_char
            return side + text + side

    def _align(self, data):
        "Align list of rows of cell"
        align = self.align
        if align == "l":
            return [line.ljust(self.width, self.fill_char) for line in data]
        elif align == "r":
            return [line.rjust(self.width, self.fill_char) for line in data]
        else:
            return [self._center(line, self.width, self.fill_char) for line in data]

    def _valign(self, data):
        "align cell vertically"
        valign = self.valign
        height = self.height
        cheight = len(data)
        excess = height - cheight
        padline = self.vfill_char * self.width

        if excess <= 0:
            return data
        # only care if we need to add new lines
        if valign == 't':
            return data + [padline for i in range(excess)]
        elif valign == 'b':
            return [padline for i in range(excess)] + data
        else: # center
            narrowside = [padline  for i in range(excess // 2)]
            widerside = narrowside + [padline]
            if excess % 2:
                # uneven padding
                if height % 2:
                    return widerside + data + narrowside
                else:
                    return narrowside + data + widerside
            else:
                # even padding, same on both sides
                return narrowside + data + narrowside

    def _pad(self, data):
        "Pad data with extra characters on all sides"
        left = self.pad_char * self.pad_left
        right = self.pad_char * self.pad_right
        vfill = (self.width + self.pad_left + self.pad_right) * self.vpad_char
        top = [vfill for i in range(self.pad_top)]
        bottom = [vfill for i in range(self.pad_bottom)]
        return top + [left + line + right for line in data] + bottom

    def _border(self, data):
        "Add borders to the cell"

        left = self.border_left_char * self.border_left
        right = self.border_right_char * self.border_right

        cwidth = self.width + self.pad_left + self.pad_right

        vfill = self.corner_top_left if left else ""
        vfill += cwidth * self.border_top_char
        vfill += self.corner_top_right if right else ""
        top = [vfill for i in range(self.border_top)]

        vfill = self.corner_bottom_left if left else ""
        vfill += cwidth * self.border_bottom_char
        vfill += self.corner_bottom_right if right else ""
        bottom = [vfill for i in range(self.border_bottom)]

        return top + [left + line + right for line in data] + bottom

    def get_height(self):
        "Get height of cell, including padding"
        return len(self.formatted)

    def get_width(self):
        "Get width of cell, including padding"
        return len(self.formatted[0]) if self.formatted else 0

    def reformat(self, **kwargs):
        """
        Reformat the Cell with new options
        kwargs:
            as the class __init__
        """
        # keywords that require manipulations
        if "width" in kwargs:
            width = kwargs.pop("width")
            self.width = width - self.pad_left - self.pad_right - self.border_left - self.border_right
            if self.width <= 0:
                raise Exception("Cell width too small, no room for data.")
        if "height" in kwargs:
            height = kwargs.pop("height")
            self.height = height - self.pad_top - self.pad_bottom - self.border_top - self.border_bottom
            if self.height <= 0:
                raise Exception("Cell height too small, no room for data.")

        pad_char = kwargs.pop("padchar", None)
        self.pad_char = pad_char[0] if pad_char else self.pad_char
        vpad_char = kwargs.pop("vpadchar", None)
        self.vpad_char = vpad_char[0] if vpad_char else self.vpad_char
        fill_char = kwargs.pop("fillchar", None)
        self.fill_char = fill_char[0] if fill_char else self.fill_char
        vfill_char = kwargs.pop("vfillchar", None)
        self.vfill_char = vfill_char[0] if vfill_char else self.vfill_char

        # fill all other properties
        for key, value in kwargs.items():
            setattr(self, key, value)

        # reformat (this is with padding)
        self.formatted = self._reformat()

    def get(self):
        """
        Get data, padded and aligned in the form of a list of lines.
        """
        return self.formatted

    def __str__(self):
        "returns cell contents on string form"
        return "\n".join(self.formatted)


# Main Evtable class

class EvTable(object):
    """
    Table class.

    This table implements an ordered grid of Cells, with
    all cell boundaries lining up.
    """

    def __init__(self, *args, **kwargs):
        """
         Args:
            headers for the table

         Keywords:
            table - list of columns (list of lists) for seeding
                    the table. If not given, the table will start
                    out empty
            border - None, or one of
                    "table" - only a border around the whole table
                    "tablecols" - table and column borders
                    "header" - only border under header
                    "cols" - only borders between columns
                    "rows" - only borders between rows
                    "cells" - border around all cells
            width - fixed width of table. If not set, width is
                    set by the total width of each column.
                    This will resize individual columns to fit.

            See also Cell class for kwargs to apply to each
            individual data cell in the table.

        """
        # table itself is a 2D grid - a list of columns
        # x is the column position, y the row
        self.table = kwargs.pop("table", [])

        # header is a list of texts. We merge it to the table's top
        header = list(args)
        self.header = header != []
        if self.header:
            if self.table:
                excess = len(header) - len(self.table)
                if excess > 0:
                    # header bigger than table
                    self.table.extend([] for i in range(excess))
                elif excess < 0:
                    # too short header
                    header.extend(["" for i in range(abs(excess))])
                for ix, heading in enumerate(header):
                    self.table[ix].insert(0, heading)
            else:
                self.table = [[heading] for heading in header]

        border = kwargs.pop("border", None)
        if not border in (None, "table", "tablecols", "header", "cols", "rows", "cells"):
            raise Exception("Unsupported border type: '%s'" % border)
        self.border = border

        self.width = kwargs.pop("width", None)
        self.horizontal = kwargs.pop("horizontal", False)
        # size in cell cols/rows
        self.ncols = 0
        self.nrows = 0
        # size in characters
        self.nwidth = 0
        self.nheight = 0
        # save options
        self.options = kwargs

        if self.table:
            # generate the table on the fly
            self.table = [[Cell(data, **kwargs) for data in col] for col in self.table]

        # this is the actual working table
        self.worktable = None

        # balance the table
        self._balance()

    def _cellborders(self, ix, iy, nx, ny, kwargs):
        """
        Adds borders to the table by adjusting the input
        kwarg to instruct cells to build a border in
        the right positions. Returns a copy of the
        kwarg to return to the cell. This is called
        by self._borders.
        """

        ret = kwargs.copy()

        def corners(ret):
            "Handle corners of table"
            if ix == 0 and iy == 0:
                ret["corner_top_left"] = cchar
            if ix == nx and iy == 0:
                ret["corner_top_right"] = cchar
            if ix == 0 and iy == ny:
                ret["corner_bottom_left"] = cchar
            if ix == nx and iy == ny:
                ret["corner_bottom_right"] = cchar
            return ret

        def left_edge(ret):
            "add vertical border along left table edge"
            if ix == 0:
                ret["border_left"] = bwidth
                ret["border_left_char"] = vchar
            return ret

        def top_edge(ret):
            "add border along top table edge"
            if iy == 0:
                ret["border_top"] = bwidth
                ret["border_top_char"] = hchar
            return ret

        def right_edge(ret):
            "add vertical border along right table edge"
            if ix == nx:# and 0 < iy < ny:
                ret["border_right"] = bwidth
                ret["border_right_char"] = vchar
            return ret

        def bottom_edge(ret):
            "add border along bottom table edge"
            if iy == ny:
                ret["border_bottom"] = bwidth
                ret["border_bottom_char"] = hchar
            return ret

        def cols(ret):
            "Adding vertical borders inside the table"
            if 0 <= ix < nx:
                ret["border_right"] = bwidth
                ret["border_right_char"] = vchar
            return ret

        def rows(ret):
            "Adding horizontal borders inside the table"
            if 0 <= iy < ny:
                ret["border_bottom"] = bwidth
                ret["border_bottom_char"] = hchar
            return ret

        def head(ret):
            "Add header underline"
            if iy == 0:
                # put different bottom line for header
                ret["border_bottom"] = bwidth
                ret["border_bottom_char"] = headchar
            return ret


        # handle the various border modes
        border = self.border
        header = self.header

        bwidth = 1
        headchar = "="
        cchar = "+"
        vchar = "|"
        hchar = "-"

        if border in ("table", "tablecols","cells"):
            ret = bottom_edge(right_edge(top_edge(left_edge(corners(ret)))))
            headchar = "-"
        if border in ("cols", "tablecols", "cells"):
            ret = cols(right_edge(left_edge(ret)))
            headchar = "-"
        if border in ("rows", "cells"):
            headchar = "="
            ret = rows(bottom_edge(top_edge(ret)))
        if header:
            ret = head(ret)

        return ret

    def _borders(self):
        """
        Add borders to table. This is called from self._balance
        """
        nx, ny = self.ncols-1, self.nrows-1
        options = self.options
        for ix, col in enumerate(self.worktable):
            for iy, cell in enumerate(col):
                cell.reformat(**self._cellborders(ix,iy,nx,ny,options))

    def _balance(self):
        """
        Balance the table. This means to make sure
        all cells on the same row have the same height,
        that all columns have the same number of rows
        and that the table fits within the given width.
        """

        # we make all modifications on a working copy of the
        # actual table. This allows us to add columns/rows
        # and re-balance over and over without issue.
        self.worktable = deepcopy(self.table)

        # balance number of rows
        ncols = len(self.worktable)
        nrows = [len(col) for col in self.worktable]
        nrowmax = max(nrows) if nrows else 0
        for icol, nrow in enumerate(nrows):
            if nrow < nrowmax:
                # add more rows
                self.worktable[icol].extend([Cell("", **self.options) for i in range(nrowmax-nrow)])

        self.ncols = ncols
        self.nrows = nrowmax

        # equalize heights for each row
        cheights = [max(cell.get_height() for cell in (col[iy] for col in self.worktable)) for iy in range(nrowmax)]

        # add borders - these add to the width/height, so we must do this before calculating width/height
        self._borders()

        # equalize widths within each column
        cwidths = [max(cell.get_width() for cell in col) for col in self.worktable]

        # width of worktable
        if self.width:
            # adjust widths of columns to fit in worktable width
            cwidth = self.width // ncols
            rest = self.width % ncols
            # get the width of each col, spreading the rest among the first cols
            cwidths = [cwidth + 1 if icol < rest else cwidth for icol, width in enumerate(cwidths)]

        # reformat worktable (for width align)
        for ix, col in enumerate(self.worktable):
            for iy, cell in enumerate(col):
                cell.reformat(width=cwidths[ix], **self.options)

        # equalize heights for each row (we must do this here, since it may have changed to fit new widths)
        cheights = [max(cell.get_height() for cell in (col[iy] for col in self.worktable)) for iy in range(nrowmax)]

        # reformat table (for vertical align)
        for ix, col in enumerate(self.worktable):
            for iy, cell in enumerate(col):
                cell.reformat(height=cheights[iy], **self.options)

        # calculate actual table width/height in characters
        self.cwidth = sum(cwidths)
        self.cheight = sum(cheights)

    def _generate_lines(self):
        """
        Generates lines across all columns
        (each cell may contain multiple lines)
        Before calling, the table must be
        balanced.
        """
        for iy in range(self.nrows):
            cell_row = [col[iy] for col in self.worktable]
            # this produces a list of lists, each of equal length
            cell_data = [cell.get() for cell in cell_row]
            print [len(lines) for lines in cell_data]
            cell_height = min(len(lines) for lines in cell_data)
            for iline in range(cell_height):
                yield "".join(celldata[iline] for celldata in cell_data)

    def add_header(self, *args, **kwargs):
        """
        Add header to table. This is a number of texts to
        be put at the top of the table. They will replace
        an existing header.
        """
        self.header = True
        self.add_row(ypos=0, *args, **kwargs)

    def add_column(self, *args, **kwargs):
        """
        Add a column to table. If there are more
        rows in new column than there are rows in the
        current table, the table will expand with
        empty rows in the other columns. If too few,
        the new column with get new empty rows. All
        filling rows are added to the end.
        keyword-
            header - the header text for the column
            xpos - index position in table before which
                   to input new column. If not given,
                   column will be added to the end. Uses
                   Python indexing (so first column is xpos=0)
        See Cell class for other keyword arguments
        """
        # this will replace default options with new ones without changing default
        options = dict(self.options.items() + kwargs.items())

        xpos = kwargs.get("xpos", None)
        column = [Cell(data, **options) for data in args]
        htable = self.nrows
        excess = self.ncols - htable

        if excess > 0:
            # we need to add new rows to table
            for col in self.table:
                col.extend([Cell("", **options) for i in range(excess)])
        elif excess < 0:
            # we need to add new rows to new column
            column.extend([Cell("", **options) for i in range(abs(excess))])

        header = kwargs.get("header", None)
        if header:
            column.insert(0, Cell(unicode(header), **options))
            self.header = True
        elif self.header:
            # we have a header already. Offset
            column.insert(0, Cell("", **options))
        if xpos is None or xpos > len(self.table) - 1:
            # add to the end
            self.table.append(column)
        else:
            # insert column
            xpos = min(len(self.table)-1, max(0, int(xpos)))
            self.table.insert(xpos, column)
        self._balance()

    def add_row(self, *args, **kwargs):
        """
        Add a row to table (not a header). If there are
        more cells in the given row than there are cells
        in the current table the table will be expanded
        with empty columns to match. These will be added
        to the end of the table. In the same way, adding
        a line with too few cells will lead to the last
        ones getting padded.
        keyword
          ypos - index position in table before which to
                 input new row. If not given, will be added
                 to the end. Uses Python indexing (so first row is
                 ypos=0)
        See Cell class for other keyword arguments
        """
        # this will replace default options with new ones without changing default
        options = dict(self.options.items() + kwargs.items())

        ypos = kwargs.get("ypos", None)
        row = [Cell(data, **options) for data in args]
        htable = len(self.table[0]) # assuming balanced table
        excess = len(row) - len(self.table)

        if excess > 0:
            # we need to add new empty columns to table
            self.table.extend([[Cell("", **options) for i in range(htable)] for k in range(excess)])
        elif excess < 0:
            # we need to add more cells to row
            row.extend([Cell("", **options) for i in range(abs(excess))])

        if ypos is None or ypos > htable - 1:
            # add new row to the end
            for icol, col in enumerate(self.table):
                col.append(row[icol])
        else:
            # insert row elsewhere
            ypos = min(htable-1, max(0, int(ypos)))
            for icol, col in enumerate(self.table):
                col.insert(ypos, row[icol])
        self._balance()

    def __str__(self):
        "print table"
        return  "\n".join([line for line in self._generate_lines()])