# parsers.py - Python implementation of parsers.c

#

# Copyright 2009 Olivia Mackall <olivia@selenic.com> and others

#

# This software may be used and distributed according to the terms of the

# GNU General Public License version 2 or any later version.

from __future__ import absolute_import

import struct

import zlib

from ..node import (

    nullrev,

    sha1nodeconstants,

)

from ..thirdparty import attr

from .. import (

    error,

    pycompat,

    revlogutils,

    util,

)

from ..revlogutils import nodemap as nodemaputil

from ..revlogutils import constants as revlog_constants

stringio = pycompat.bytesio

_pack = struct.pack

_unpack = struct.unpack

_compress = zlib.compress

_decompress = zlib.decompress

# a special value used internally for `size` if the file come from the other parent

FROM_P2 = -2

# a special value used internally for `size` if the file is modified/merged/added

NONNORMAL = -1

# a special value used internally for `time` if the time is ambigeous

AMBIGUOUS_TIME = -1

@attr.s(slots=True, init=False)

class DirstateItem(object):

    """represent a dirstate entry

    It contains:

    - state (one of 'n', 'a', 'r', 'm')

    - mode,

    - size,

    - mtime,

    """

    _mode = attr.ib()

    _size = attr.ib()

    _mtime = attr.ib()

    def __init__(

        self,

        wc_tracked=False,

        p1_tracked=False,

        p2_tracked=False,

        merged=False,

        clean_p1=False,

        clean_p2=False,

        possibly_dirty=False,

        parentfiledata=None,

    ):

        if merged and (clean_p1 or clean_p2):

            msg = b'`merged` argument incompatible with `clean_p1`/`clean_p2`'

            raise error.ProgrammingError(msg)

            self._mode = parentfiledata[0]

            self._size = parentfiledata[1]

            self._mtime = parentfiledata[2]

    @classmethod

    def new_added(cls):

        """constructor to help legacy API to build a new "added" item

        Should eventually be removed

        """

        instance = cls()

        return instance

    @classmethod

    def new_merged(cls):

        """constructor to help legacy API to build a new "merged" item

        Should eventually be removed

        """

        instance = cls()

        return instance

    @classmethod

    def new_from_p2(cls):

        """constructor to help legacy API to build a new "from_p2" item

        Should eventually be removed

        """

        instance = cls()

        return instance

    @classmethod

    def new_possibly_dirty(cls):

        """constructor to help legacy API to build a new "possibly_dirty" item

        Should eventually be removed

        """

        instance = cls()

        return instance

    @classmethod

    def new_normal(cls, mode, size, mtime):

        """constructor to help legacy API to build a new "normal" item

        Should eventually be removed

        """

        assert size != FROM_P2

        assert size != NONNORMAL

        instance = cls()

        instance._mode = mode

        instance._size = size

        instance._mtime = mtime

        return instance

    @classmethod

    def from_v1_data(cls, state, mode, size, mtime):

        """Build a new DirstateItem object from V1 data

        Since the dirstate-v1 format is frozen, the signature of this function

        is not expected to change, unlike the __init__ one.

        """

    def set_possibly_dirty(self):

        """Mark a file as "possibly dirty"

        This means the next status call will have to actually check its content

        to make sure it is correct.

        """

    def set_untracked(self):

        """mark a file as untracked in the working copy

        This will ultimately be called by command like `hg remove`.

        """

        # backup the previous state (useful for merge)

    @property

    def mode(self):

        return self.v1_mode()

    @property

    def size(self):

        return self.v1_size()

    @property

    def mtime(self):

        return self.v1_mtime()

    @property

    def state(self):

        """

        States are:

          n  normal

          m  needs merging

          r  marked for removal

          a  marked for addition

        XXX This "state" is a bit obscure and mostly a direct expression of the

        dirstatev1 format. It would make sense to ultimately deprecate it in

        favor of the more "semantic" attributes.

        """

        return self.v1_state()

    @property

    def tracked(self):

        """True is the file is tracked in the working copy"""

        return self.v1_state() in b"nma"

    @property

    def added(self):

        """True if the file has been added"""

        return self.v1_state() == b'a'

    @property

    def merged(self):

        """True if the file has been merged

        Should only be set if a merge is in progress in the dirstate

        """

        return self.v1_state() == b'm'

    @property

    def from_p2(self):

        """True if the file have been fetched from p2 during the current merge

        This is only True is the file is currently tracked.

        Should only be set if a merge is in progress in the dirstate

        """

        return self.v1_state() == b'n' and self.v1_size() == FROM_P2

    @property

    def from_p2_removed(self):

        """True if the file has been removed, but was "from_p2" initially

        This property seems like an abstraction leakage and should probably be

        dealt in this class (or maybe the dirstatemap) directly.

        """

        return self.v1_state() == b'r' and self.v1_size() == FROM_P2

    @property

    def removed(self):

        """True if the file has been removed"""

        return self.v1_state() == b'r'

    @property

    def merged_removed(self):

        """True if the file has been removed, but was "merged" initially

        This property seems like an abstraction leakage and should probably be

        dealt in this class (or maybe the dirstatemap)  directly.

        """

        return self.v1_state() == b'r' and self.v1_size() == NONNORMAL

    @property

    def dm_nonnormal(self):

        """True is the entry is non-normal in the dirstatemap sense

        There is no reason for any code, but the dirstatemap one to use this.

        """

        return self.v1_state() != b'n' or self.v1_mtime() == AMBIGUOUS_TIME

    @property

    def dm_otherparent(self):

        """True is the entry is `otherparent` in the dirstatemap sense

        There is no reason for any code, but the dirstatemap one to use this.

        """

        return self.v1_size() == FROM_P2

    def v1_state(self):

        """return a "state" suitable for v1 serialization"""

    def v1_mode(self):

        """return a "mode" suitable for v1 serialization"""

    def v1_size(self):

        """return a "size" suitable for v1 serialization"""

    def v1_mtime(self):

        """return a "mtime" suitable for v1 serialization"""