# 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 hold multiple attributes

    # about file tracking

    - wc_tracked: is the file tracked by the working copy

    - p1_tracked: is the file tracked in working copy first parent

    - p2_tracked: is the file tracked in working copy second parent

    # about what possible merge action related to this file

    - clean_p1: merge picked the file content from p1

    - clean_p2: merge picked the file content from p2

    - merged: file gather changes from both side.

    # about the file state expected from p1 manifest:

    - mode: the file mode in p1

    - size: the file size in p1

    # about the file state on disk last time we saw it:

    - mtime: the last known clean mtime for the file.

    The last three item (mode, size and mtime) can be None if no meaningful (or

    trusted) value exists.

    """

    _wc_tracked = attr.ib()

    _p1_tracked = attr.ib()

    _p2_tracked = attr.ib()

    # the three item above should probably be combined

    #

    # However it is unclear if they properly cover some of the most advanced

    # merge case. So we should probably wait on this to be settled.

    _merged = attr.ib()

    _clean_p1 = attr.ib()

    _clean_p2 = attr.ib()

    _possibly_dirty = attr.ib()

    _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._wc_tracked = wc_tracked

        self._p1_tracked = p1_tracked

        self._p2_tracked = p2_tracked

        self._merged = merged

        self._clean_p1 = clean_p1

        self._clean_p2 = clean_p2

        self._possibly_dirty = possibly_dirty

        if parentfiledata is None:

            self._mode = None

            self._size = None

            self._mtime = None

        else:

            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()

        instance._wc_tracked = True

        instance._p1_tracked = False

        instance._p2_tracked = False

        return instance

    @classmethod

    def new_merged(cls):

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

        Should eventually be removed

        """

        instance = cls()

        instance._wc_tracked = True

        instance._p1_tracked = True  # might not be True because of rename ?

        instance._p2_tracked = True  # might not be True because of rename ?

        instance._merged = True

        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()

        instance._wc_tracked = True

        instance._p1_tracked = False  # might actually be True

        instance._p2_tracked = True

        instance._clean_p2 = True

        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()

        instance._wc_tracked = True

        instance._p1_tracked = True

        instance._possibly_dirty = True

        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._wc_tracked = True

        instance._p1_tracked = True

        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.

        """

        if state == b'm':

            return cls.new_merged()

        elif state == b'a':

            return cls.new_added()

        elif state == b'r':

            instance = cls()

            instance._wc_tracked = False

            if size == NONNORMAL:

                instance._merged = True

                instance._p1_tracked = (

                    True  # might not be True because of rename ?

                )

                instance._p2_tracked = (

                    True  # might not be True because of rename ?

                )

            elif size == FROM_P2:

                instance._clean_p2 = True

                instance._p1_tracked = (

                    False  # We actually don't know (file history)

                )

                instance._p2_tracked = True

            else:

                instance._p1_tracked = True

            return instance

        elif state == b'n':

            if size == FROM_P2:

                return cls.new_from_p2()

            elif size == NONNORMAL:

                return cls.new_possibly_dirty()

            elif mtime == AMBIGUOUS_TIME:

                instance = cls.new_normal(mode, size, 42)

                instance._mtime = None

                instance._possibly_dirty = True

                return instance

            else:

                return cls.new_normal(mode, size, mtime)

        else:

            raise RuntimeError(b'unknown state: %s' % state)

    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.

        """

        self._possibly_dirty = True

    def set_clean(self, mode, size, mtime):

        """mark a file as "clean" cancelling potential "possibly dirty call"

        Note: this function is a descendant of `dirstate.normal` and is

        currently expected to be call on "normal" entry only. There are not

        reason for this to not change in the future as long as the ccode is

        updated to preserve the proper state of the non-normal files.

        """

        self._wc_tracked = True

        self._p1_tracked = True

        self._p2_tracked = False  # this might be wrong

        self._merged = False

        self._clean_p2 = False

        self._possibly_dirty = False

        self._mode = mode

        self._size = size

        self._mtime = mtime

    def set_tracked(self):

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

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

        """

        self._wc_tracked = True

        # `set_tracked` is replacing various `normallookup` call. So we set

        # "possibly dirty" to stay on the safe side.

        #

        # Consider dropping this in the future in favor of something less broad.

        self._possibly_dirty = True

    def set_untracked(self):

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

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

        """

        self._wc_tracked = False

        self._mode = None

        self._size = None

        self._mtime = None

    def drop_merge_data(self):

        """remove all "merge-only" from a DirstateItem

        This is to be call by the dirstatemap code when the second parent is dropped

        """

        if not (self.merged or self.from_p2):

            return

        self._p1_tracked = self.merged  # why is this not already properly set ?

        self._merged = False

        self._clean_p1 = False

        self._clean_p2 = False

        self._p2_tracked = False

        self._possibly_dirty = True

        self._mode = None

        self._size = None

        self._mtime = None

    @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.

        """

        if not self.any_tracked:

            return b'?'

        return self.v1_state()

    @property

    def tracked(self):

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

        return self._wc_tracked

    @property

    def any_tracked(self):

        """True is the file is tracked anywhere (wc or parents)"""

        return self._wc_tracked or self._p1_tracked or self._p2_tracked

    @property

    def added(self):

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

        return self._wc_tracked and not (self._p1_tracked or self._p2_tracked)

    @property

    def maybe_clean(self):

        """True if the file has a chance to be in the "clean" state"""

        if not self._wc_tracked:

            return False

        elif self.added:

            return False

        elif self._merged:

            return False

        elif self._clean_p2:

            return False

        return True

    @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._wc_tracked and self._merged

    @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

        """

        if not self._wc_tracked:

            return False

        return self._clean_p2

    @property

    def removed(self):

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

        return not self._wc_tracked and (self._p1_tracked or self._p2_tracked)

    def v1_state(self):

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

        if not (self._p1_tracked or self._p2_tracked or self._wc_tracked):

            # the object has no state to record, this is -currently-

            # unsupported

            raise RuntimeError('untracked item')

        elif self.removed:

            return b'r'

        elif self.merged:

            return b'm'

        elif self.added:

            return b'a'

        else:

            return b'n'

    def v1_mode(self):

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

        return self._mode if self._mode is not None else 0

    def v1_size(self):

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

        if not self.any_tracked:

            # the object has no state to record, this is -currently-

            # unsupported

            raise RuntimeError('untracked item')

        elif self.removed and self._merged:

            return NONNORMAL

        elif self.removed and self._clean_p2:

            return FROM_P2

        elif self.removed: