(*  Title:      HOL/Word/Word.thy

    Author:     Jeremy Dawson and Gerwin Klein, NICTA

*)

section \<open>A type of finite bit strings\<close>

theory Word

imports

  Type_Length

  "~~/src/HOL/Library/Boolean_Algebra"

  Bits_Bit

  Bool_List_Representation

  Misc_Typedef

  Word_Miscellaneous

begin

text \<open>See @{file "Examples/WordExamples.thy"} for examples.\<close>

subsection \<open>Type definition\<close>

typedef (overloaded) 'a word = "{(0::int) ..< 2 ^ len_of TYPE('a::len0)}"

  morphisms uint Abs_word by auto

lemma uint_nonnegative:

  "0 \<le> uint w"

  using word.uint [of w] by simp

lemma uint_bounded:

  fixes w :: "'a::len0 word"

  shows "uint w < 2 ^ len_of TYPE('a)"

  using word.uint [of w] by simp

lemma uint_idem:

  fixes w :: "'a::len0 word"

  shows "uint w mod 2 ^ len_of TYPE('a) = uint w"

  using uint_nonnegative uint_bounded by (rule mod_pos_pos_trivial)

lemma word_uint_eq_iff:

  "a = b \<longleftrightarrow> uint a = uint b"

  by (simp add: uint_inject)

lemma word_uint_eqI:

  "uint a = uint b \<Longrightarrow> a = b"

  by (simp add: word_uint_eq_iff)

definition word_of_int :: "int \<Rightarrow> 'a::len0 word"

where

  \<comment> \<open>representation of words using unsigned or signed bins,

    only difference in these is the type class\<close>

  "word_of_int k = Abs_word (k mod 2 ^ len_of TYPE('a))"

lemma uint_word_of_int:

  "uint (word_of_int k :: 'a::len0 word) = k mod 2 ^ len_of TYPE('a)"

  by (auto simp add: word_of_int_def intro: Abs_word_inverse)

lemma word_of_int_uint:

  "word_of_int (uint w) = w"

  by (simp add: word_of_int_def uint_idem uint_inverse)

lemma split_word_all:

  "(\<And>x::'a::len0 word. PROP P x) \<equiv> (\<And>x. PROP P (word_of_int x))"

proof

  fix x :: "'a word"

  assume "\<And>x. PROP P (word_of_int x)"

  then have "PROP P (word_of_int (uint x))" .

  then show "PROP P x" by (simp add: word_of_int_uint)

qed

subsection \<open>Type conversions and casting\<close>

definition sint :: "'a::len word \<Rightarrow> int"

where

  \<comment> \<open>treats the most-significant-bit as a sign bit\<close>

  sint_uint: "sint w = sbintrunc (len_of TYPE ('a) - 1) (uint w)"

definition unat :: "'a::len0 word \<Rightarrow> nat"

where

  "unat w = nat (uint w)"

definition uints :: "nat \<Rightarrow> int set"

where

  \<comment> "the sets of integers representing the words"

  "uints n = range (bintrunc n)"

definition sints :: "nat \<Rightarrow> int set"

where

  "sints n = range (sbintrunc (n - 1))"

lemma uints_num:

  "uints n = {i. 0 \<le> i \<and> i < 2 ^ n}"

  by (simp add: uints_def range_bintrunc)

lemma sints_num:

  "sints n = {i. - (2 ^ (n - 1)) \<le> i \<and> i < 2 ^ (n - 1)}"

  by (simp add: sints_def range_sbintrunc)

definition unats :: "nat \<Rightarrow> nat set"

where

  "unats n = {i. i < 2 ^ n}"

definition norm_sint :: "nat \<Rightarrow> int \<Rightarrow> int"

where

  "norm_sint n w = (w + 2 ^ (n - 1)) mod 2 ^ n - 2 ^ (n - 1)"

definition scast :: "'a::len word \<Rightarrow> 'b::len word"

where

  \<comment> "cast a word to a different length"

  "scast w = word_of_int (sint w)"

definition ucast :: "'a::len0 word \<Rightarrow> 'b::len0 word"

where

  "ucast w = word_of_int (uint w)"

instantiation word :: (len0) size

begin

definition

  word_size: "size (w :: 'a word) = len_of TYPE('a)"

instance ..

end

lemma word_size_gt_0 [iff]:

  "0 < size (w::'a::len word)"

  by (simp add: word_size)

lemmas lens_gt_0 = word_size_gt_0 len_gt_0

lemma lens_not_0 [iff]:

  shows "size (w::'a::len word) \<noteq> 0"

  and "len_of TYPE('a::len) \<noteq> 0"

  by auto

definition source_size :: "('a::len0 word \<Rightarrow> 'b) \<Rightarrow> nat"

where

  \<comment> "whether a cast (or other) function is to a longer or shorter length"

  [code del]: "source_size c = (let arb = undefined; x = c arb in size arb)"

definition target_size :: "('a \<Rightarrow> 'b::len0 word) \<Rightarrow> nat"

where

  [code del]: "target_size c = size (c undefined)"

definition is_up :: "('a::len0 word \<Rightarrow> 'b::len0 word) \<Rightarrow> bool"

where

  "is_up c \<longleftrightarrow> source_size c \<le> target_size c"

definition is_down :: "('a :: len0 word \<Rightarrow> 'b :: len0 word) \<Rightarrow> bool"

where

  "is_down c \<longleftrightarrow> target_size c \<le> source_size c"

definition of_bl :: "bool list \<Rightarrow> 'a::len0 word"

where

  "of_bl bl = word_of_int (bl_to_bin bl)"

definition to_bl :: "'a::len0 word \<Rightarrow> bool list"

where

  "to_bl w = bin_to_bl (len_of TYPE ('a)) (uint w)"

definition word_reverse :: "'a::len0 word \<Rightarrow> 'a word"

where

  "word_reverse w = of_bl (rev (to_bl w))"

definition word_int_case :: "(int \<Rightarrow> 'b) \<Rightarrow> 'a::len0 word \<Rightarrow> 'b" 

where

  "word_int_case f w = f (uint w)"

translations

  "case x of XCONST of_int y => b" == "CONST word_int_case (%y. b) x"

  "case x of (XCONST of_int :: 'a) y => b" => "CONST word_int_case (%y. b) x"

subsection \<open>Correspondence relation for theorem transfer\<close>

definition cr_word :: "int \<Rightarrow> 'a::len0 word \<Rightarrow> bool"

where

  "cr_word = (\<lambda>x y. word_of_int x = y)"

lemma Quotient_word:

  "Quotient (\<lambda>x y. bintrunc (len_of TYPE('a)) x = bintrunc (len_of TYPE('a)) y)

    word_of_int uint (cr_word :: _ \<Rightarrow> 'a::len0 word \<Rightarrow> bool)"

  unfolding Quotient_alt_def cr_word_def

  by (simp add: no_bintr_alt1 word_of_int_uint) (simp add: word_of_int_def Abs_word_inject)

lemma reflp_word:

  "reflp (\<lambda>x y. bintrunc (len_of TYPE('a::len0)) x = bintrunc (len_of TYPE('a)) y)"

  by (simp add: reflp_def)

setup_lifting Quotient_word reflp_word

text \<open>TODO: The next lemma could be generated automatically.\<close>

lemma uint_transfer [transfer_rule]:

  "(rel_fun pcr_word op =) (bintrunc (len_of TYPE('a)))

    (uint :: 'a::len0 word \<Rightarrow> int)"

  unfolding rel_fun_def word.pcr_cr_eq cr_word_def

  by (simp add: no_bintr_alt1 uint_word_of_int)

subsection \<open>Basic code generation setup\<close>

definition Word :: "int \<Rightarrow> 'a::len0 word"

where

  [code_post]: "Word = word_of_int"

lemma [code abstype]:

  "Word (uint w) = w"

  by (simp add: Word_def word_of_int_uint)

declare uint_word_of_int [code abstract]

instantiation word :: (len0) equal

begin

definition equal_word :: "'a word \<Rightarrow> 'a word \<Rightarrow> bool"

where

  "equal_word k l \<longleftrightarrow> HOL.equal (uint k) (uint l)"

instance proof

qed (simp add: equal equal_word_def word_uint_eq_iff)

end

notation fcomp (infixl "\<circ>>" 60)

notation scomp (infixl "\<circ>\<rightarrow>" 60)

instantiation word :: ("{len0, typerep}") random

begin

definition

  "random_word i = Random.range i \<circ>\<rightarrow> (\<lambda>k. Pair (

     let j = word_of_int (int_of_integer (integer_of_natural k)) :: 'a word

     in (j, \<lambda>_::unit. Code_Evaluation.term_of j)))"

instance ..

end

no_notation fcomp (infixl "\<circ>>" 60)

no_notation scomp (infixl "\<circ>\<rightarrow>" 60)

subsection \<open>Type-definition locale instantiations\<close>

lemmas uint_0 = uint_nonnegative (* FIXME duplicate *)

lemmas uint_lt = uint_bounded (* FIXME duplicate *)

lemmas uint_mod_same = uint_idem (* FIXME duplicate *)

lemma td_ext_uint: 

  "td_ext (uint :: 'a word \<Rightarrow> int) word_of_int (uints (len_of TYPE('a::len0))) 

    (\<lambda>w::int. w mod 2 ^ len_of TYPE('a))"

  apply (unfold td_ext_def')

  apply (simp add: uints_num word_of_int_def bintrunc_mod2p)

  apply (simp add: uint_mod_same uint_0 uint_lt

                   word.uint_inverse word.Abs_word_inverse int_mod_lem)

  done

interpretation word_uint:

  td_ext "uint::'a::len0 word \<Rightarrow> int" 

         word_of_int 

         "uints (len_of TYPE('a::len0))"

         "\<lambda>w. w mod 2 ^ len_of TYPE('a::len0)"

  by (fact td_ext_uint)

lemmas td_uint = word_uint.td_thm

lemmas int_word_uint = word_uint.eq_norm

lemma td_ext_ubin:

  "td_ext (uint :: 'a word \<Rightarrow> int) word_of_int (uints (len_of TYPE('a::len0)))

    (bintrunc (len_of TYPE('a)))"

  by (unfold no_bintr_alt1) (fact td_ext_uint)

interpretation word_ubin:

  td_ext "uint::'a::len0 word \<Rightarrow> int" 

         word_of_int 

         "uints (len_of TYPE('a::len0))"

         "bintrunc (len_of TYPE('a::len0))"

  by (fact td_ext_ubin)

subsection \<open>Arithmetic operations\<close>

lift_definition word_succ :: "'a::len0 word \<Rightarrow> 'a word" is "\<lambda>x. x + 1"

  by (metis bintr_ariths(6))

lift_definition word_pred :: "'a::len0 word \<Rightarrow> 'a word" is "\<lambda>x. x - 1"

  by (metis bintr_ariths(7))

instantiation word :: (len0) "{neg_numeral, Divides.div, comm_monoid_mult, comm_ring}"

begin

lift_definition zero_word :: "'a word" is "0" .

lift_definition one_word :: "'a word" is "1" .

lift_definition plus_word :: "'a word \<Rightarrow> 'a word \<Rightarrow> 'a word" is "op +"

  by (metis bintr_ariths(2))

lift_definition minus_word :: "'a word \<Rightarrow> 'a word \<Rightarrow> 'a word" is "op -"

  by (metis bintr_ariths(3))

lift_definition uminus_word :: "'a word \<Rightarrow> 'a word" is uminus

  by (metis bintr_ariths(5))

lift_definition times_word :: "'a word \<Rightarrow> 'a word \<Rightarrow> 'a word" is "op *"

  by (metis bintr_ariths(4))

definition

  word_div_def: "a div b = word_of_int (uint a div uint b)"

definition

  word_mod_def: "a mod b = word_of_int (uint a mod uint b)"

instance

  by standard (transfer, simp add: algebra_simps)+

end

text \<open>Legacy theorems:\<close>

lemma word_arith_wis [code]: shows

  word_add_def: "a + b = word_of_int (uint a + uint b)" and

  word_sub_wi: "a - b = word_of_int (uint a - uint b)" and

  word_mult_def: "a * b = word_of_int (uint a * uint b)" and

  word_minus_def: "- a = word_of_int (- uint a)" and

  word_succ_alt: "word_succ a = word_of_int (uint a + 1)" and

  word_pred_alt: "word_pred a = word_of_int (uint a - 1)" and

  word_0_wi: "0 = word_of_int 0" and

  word_1_wi: "1 = word_of_int 1"

  unfolding plus_word_def minus_word_def times_word_def uminus_word_def

  unfolding word_succ_def word_pred_def zero_word_def one_word_def

  by simp_all

lemmas arths = 

  bintr_ariths [THEN word_ubin.norm_eq_iff [THEN iffD1], folded word_ubin.eq_norm]

lemma wi_homs: 

  shows

  wi_hom_add: "word_of_int a + word_of_int b = word_of_int (a + b)" and

  wi_hom_sub: "word_of_int a - word_of_int b = word_of_int (a - b)" and

  wi_hom_mult: "word_of_int a * word_of_int b = word_of_int (a * b)" and

  wi_hom_neg: "- word_of_int a = word_of_int (- a)" and

  wi_hom_succ: "word_succ (word_of_int a) = word_of_int (a + 1)" and

  wi_hom_pred: "word_pred (word_of_int a) = word_of_int (a - 1)"

  by (transfer, simp)+

lemmas wi_hom_syms = wi_homs [symmetric]

lemmas word_of_int_homs = wi_homs word_0_wi word_1_wi

lemmas word_of_int_hom_syms = word_of_int_homs [symmetric]

instance word :: (len) comm_ring_1

proof

  have "0 < len_of TYPE('a)" by (rule len_gt_0)

  then show "(0::'a word) \<noteq> 1"

    by - (transfer, auto simp add: gr0_conv_Suc)

qed

lemma word_of_nat: "of_nat n = word_of_int (int n)"

  by (induct n) (auto simp add : word_of_int_hom_syms)

lemma word_of_int: "of_int = word_of_int"

  apply (rule ext)

  apply (case_tac x rule: int_diff_cases)

  apply (simp add: word_of_nat wi_hom_sub)

  done

definition udvd :: "'a::len word => 'a::len word => bool" (infixl "udvd" 50)

where

  "a udvd b = (EX n>=0. uint b = n * uint a)"

subsection \<open>Ordering\<close>

instantiation word :: (len0) linorder

begin

definition

  word_le_def: "a \<le> b \<longleftrightarrow> uint a \<le> uint b"

definition

  word_less_def: "a < b \<longleftrightarrow> uint a < uint b"

instance

  by standard (auto simp: word_less_def word_le_def)

end

definition word_sle :: "'a :: len word => 'a word => bool" ("(_/ <=s _)" [50, 51] 50)

where

  "a <=s b = (sint a <= sint b)"

definition word_sless :: "'a :: len word => 'a word => bool" ("(_/ <s _)" [50, 51] 50)

where

  "(x <s y) = (x <=s y & x ~= y)"

subsection \<open>Bit-wise operations\<close>

instantiation word :: (len0) bits

begin

lift_definition bitNOT_word :: "'a word \<Rightarrow> 'a word" is bitNOT

  by (metis bin_trunc_not)

lift_definition bitAND_word :: "'a word \<Rightarrow> 'a word \<Rightarrow> 'a word" is bitAND

  by (metis bin_trunc_and)

lift_definition bitOR_word :: "'a word \<Rightarrow> 'a word \<Rightarrow> 'a word" is bitOR

  by (metis bin_trunc_or)

lift_definition bitXOR_word :: "'a word \<Rightarrow> 'a word \<Rightarrow> 'a word" is bitXOR

  by (metis bin_trunc_xor)

definition

  word_test_bit_def: "test_bit a = bin_nth (uint a)"

definition

  word_set_bit_def: "set_bit a n x =

   word_of_int (bin_sc n x (uint a))"

definition

  word_set_bits_def: "(BITS n. f n) = of_bl (bl_of_nth (len_of TYPE ('a)) f)"

definition

  word_lsb_def: "lsb a \<longleftrightarrow> bin_last (uint a)"

definition shiftl1 :: "'a word \<Rightarrow> 'a word"

where

  "shiftl1 w = word_of_int (uint w BIT False)"

definition shiftr1 :: "'a word \<Rightarrow> 'a word"

where

  \<comment> "shift right as unsigned or as signed, ie logical or arithmetic"

  "shiftr1 w = word_of_int (bin_rest (uint w))"

definition

  shiftl_def: "w << n = (shiftl1 ^^ n) w"

definition

  shiftr_def: "w >> n = (shiftr1 ^^ n) w"

instance ..

end

lemma [code]: shows

  word_not_def: "NOT (a::'a::len0 word) = word_of_int (NOT (uint a))" and

  word_and_def: "(a::'a word) AND b = word_of_int (uint a AND uint b)" and

  word_or_def: "(a::'a word) OR b = word_of_int (uint a OR uint b)" and

  word_xor_def: "(a::'a word) XOR b = word_of_int (uint a XOR uint b)"

  unfolding bitNOT_word_def bitAND_word_def bitOR_word_def bitXOR_word_def

  by simp_all

instantiation word :: (len) bitss

begin

definition

  word_msb_def: 

  "msb a \<longleftrightarrow> bin_sign (sint a) = -1"

instance ..

end

definition setBit :: "'a :: len0 word => nat => 'a word"

where 

  "setBit w n = set_bit w n True"

definition clearBit :: "'a :: len0 word => nat => 'a word"

where

  "clearBit w n = set_bit w n False"

subsection \<open>Shift operations\<close>

definition sshiftr1 :: "'a :: len word => 'a word"

where 

  "sshiftr1 w = word_of_int (bin_rest (sint w))"

definition bshiftr1 :: "bool => 'a :: len word => 'a word"

where

  "bshiftr1 b w = of_bl (b # butlast (to_bl w))"

definition sshiftr :: "'a :: len word => nat => 'a word" (infixl ">>>" 55)

where

  "w >>> n = (sshiftr1 ^^ n) w"

definition mask :: "nat => 'a::len word"

where

  "mask n = (1 << n) - 1"

definition revcast :: "'a :: len0 word => 'b :: len0 word"

where

  "revcast w =  of_bl (takefill False (len_of TYPE('b)) (to_bl w))"

definition slice1 :: "nat => 'a :: len0 word => 'b :: len0 word"

where

  "slice1 n w = of_bl (takefill False n (to_bl w))"

definition slice :: "nat => 'a :: len0 word => 'b :: len0 word"

where

  "slice n w = slice1 (size w - n) w"

subsection \<open>Rotation\<close>

definition rotater1 :: "'a list => 'a list"

where

  "rotater1 ys = 

    (case ys of [] => [] | x # xs => last ys # butlast ys)"

definition rotater :: "nat => 'a list => 'a list"

where

  "rotater n = rotater1 ^^ n"

definition word_rotr :: "nat => 'a :: len0 word => 'a :: len0 word"

where

  "word_rotr n w = of_bl (rotater n (to_bl w))"

definition word_rotl :: "nat => 'a :: len0 word => 'a :: len0 word"

where

  "word_rotl n w = of_bl (rotate n (to_bl w))"

definition word_roti :: "int => 'a :: len0 word => 'a :: len0 word"

where

  "word_roti i w = (if i >= 0 then word_rotr (nat i) w

                    else word_rotl (nat (- i)) w)"

subsection \<open>Split and cat operations\<close>

definition word_cat :: "'a :: len0 word => 'b :: len0 word => 'c :: len0 word"

where

  "word_cat a b = word_of_int (bin_cat (uint a) (len_of TYPE ('b)) (uint b))"

definition word_split :: "'a :: len0 word => ('b :: len0 word) * ('c :: len0 word)"

where

  "word_split a = 

   (case bin_split (len_of TYPE ('c)) (uint a) of 

     (u, v) => (word_of_int u, word_of_int v))"

definition word_rcat :: "'a :: len0 word list => 'b :: len0 word"

where

  "word_rcat ws = 

  word_of_int (bin_rcat (len_of TYPE ('a)) (map uint ws))"

definition word_rsplit :: "'a :: len0 word => 'b :: len word list"

where

  "word_rsplit w = 

  map word_of_int (bin_rsplit (len_of TYPE ('b)) (len_of TYPE ('a), uint w))"

definition max_word :: "'a::len word" \<comment> "Largest representable machine integer."

where

  "max_word = word_of_int (2 ^ len_of TYPE('a) - 1)"

lemmas of_nth_def = word_set_bits_def (* FIXME duplicate *)

subsection \<open>Theorems about typedefs\<close>

lemma sint_sbintrunc': 

  "sint (word_of_int bin :: 'a word) = 

    (sbintrunc (len_of TYPE ('a :: len) - 1) bin)"

  unfolding sint_uint 

  by (auto simp: word_ubin.eq_norm sbintrunc_bintrunc_lt)

lemma uint_sint: 

  "uint w = bintrunc (len_of TYPE('a)) (sint (w :: 'a :: len word))"

  unfolding sint_uint by (auto simp: bintrunc_sbintrunc_le)

lemma bintr_uint:

  fixes w :: "'a::len0 word"

  shows "len_of TYPE('a) \<le> n \<Longrightarrow> bintrunc n (uint w) = uint w"

  apply (subst word_ubin.norm_Rep [symmetric]) 

  apply (simp only: bintrunc_bintrunc_min word_size)

  apply (simp add: min.absorb2)

  done

lemma wi_bintr:

  "len_of TYPE('a::len0) \<le> n \<Longrightarrow>

    word_of_int (bintrunc n w) = (word_of_int w :: 'a word)"

  by (clarsimp simp add: word_ubin.norm_eq_iff [symmetric] min.absorb1)

lemma td_ext_sbin: 

  "td_ext (sint :: 'a word \<Rightarrow> int) word_of_int (sints (len_of TYPE('a::len))) 

    (sbintrunc (len_of TYPE('a) - 1))"

  apply (unfold td_ext_def' sint_uint)

  apply (simp add : word_ubin.eq_norm)

  apply (cases "len_of TYPE('a)")

   apply (auto simp add : sints_def)

  apply (rule sym [THEN trans])

  apply (rule word_ubin.Abs_norm)

  apply (simp only: bintrunc_sbintrunc)

  apply (drule sym)

  apply simp

  done

lemma td_ext_sint:

  "td_ext (sint :: 'a word \<Rightarrow> int) word_of_int (sints (len_of TYPE('a::len)))

     (\<lambda>w. (w + 2 ^ (len_of TYPE('a) - 1)) mod 2 ^ len_of TYPE('a) -

         2 ^ (len_of TYPE('a) - 1))"

  using td_ext_sbin [where ?'a = 'a] by (simp add: no_sbintr_alt2)

(* We do sint before sbin, before sint is the user version

   and interpretations do not produce thm duplicates. I.e. 

   we get the name word_sint.Rep_eqD, but not word_sbin.Req_eqD,

   because the latter is the same thm as the former *)

interpretation word_sint:

  td_ext "sint ::'a::len word => int" 

          word_of_int 

          "sints (len_of TYPE('a::len))"

          "%w. (w + 2^(len_of TYPE('a::len) - 1)) mod 2^len_of TYPE('a::len) -

               2 ^ (len_of TYPE('a::len) - 1)"

  by (rule td_ext_sint)

interpretation word_sbin:

  td_ext "sint ::'a::len word => int" 

          word_of_int 

          "sints (len_of TYPE('a::len))"

          "sbintrunc (len_of TYPE('a::len) - 1)"

  by (rule td_ext_sbin)

lemmas int_word_sint = td_ext_sint [THEN td_ext.eq_norm]

lemmas td_sint = word_sint.td

lemma to_bl_def': 

  "(to_bl :: 'a :: len0 word => bool list) =

    bin_to_bl (len_of TYPE('a)) o uint"

  by (auto simp: to_bl_def)

lemmas word_reverse_no_def [simp] = word_reverse_def [of "numeral w"] for w

lemma uints_mod: "uints n = range (\<lambda>w. w mod 2 ^ n)"

  by (fact uints_def [unfolded no_bintr_alt1])

lemma word_numeral_alt:

  "numeral b = word_of_int (numeral b)"

  by (induct b, simp_all only: numeral.simps word_of_int_homs)

declare word_numeral_alt [symmetric, code_abbrev]

lemma word_neg_numeral_alt:

  "- numeral b = word_of_int (- numeral b)"

  by (simp only: word_numeral_alt wi_hom_neg)

declare word_neg_numeral_alt [symmetric, code_abbrev]

lemma word_numeral_transfer [transfer_rule]:

  "(rel_fun op = pcr_word) numeral numeral"

  "(rel_fun op = pcr_word) (- numeral) (- numeral)"

  apply (simp_all add: rel_fun_def word.pcr_cr_eq cr_word_def)

  using word_numeral_alt [symmetric] word_neg_numeral_alt [symmetric] by blast+

lemma uint_bintrunc [simp]:

  "uint (numeral bin :: 'a word) = 

    bintrunc (len_of TYPE ('a :: len0)) (numeral bin)"

  unfolding word_numeral_alt by (rule word_ubin.eq_norm)

lemma uint_bintrunc_neg [simp]: "uint (- numeral bin :: 'a word) = 

    bintrunc (len_of TYPE ('a :: len0)) (- numeral bin)"

  by (simp only: word_neg_numeral_alt word_ubin.eq_norm)

lemma sint_sbintrunc [simp]:

  "sint (numeral bin :: 'a word) = 

    sbintrunc (len_of TYPE ('a :: len) - 1) (numeral bin)"

  by (simp only: word_numeral_alt word_sbin.eq_norm)

lemma sint_sbintrunc_neg [simp]: "sint (- numeral bin :: 'a word) = 

    sbintrunc (len_of TYPE ('a :: len) - 1) (- numeral bin)"

  by (simp only: word_neg_numeral_alt word_sbin.eq_norm)

lemma unat_bintrunc [simp]:

  "unat (numeral bin :: 'a :: len0 word) =

    nat (bintrunc (len_of TYPE('a)) (numeral bin))"

  by (simp only: unat_def uint_bintrunc)

lemma unat_bintrunc_neg [simp]:

  "unat (- numeral bin :: 'a :: len0 word) =

    nat (bintrunc (len_of TYPE('a)) (- numeral bin))"

  by (simp only: unat_def uint_bintrunc_neg)

lemma size_0_eq: "size (w :: 'a :: len0 word) = 0 \<Longrightarrow> v = w"

  apply (unfold word_size)

  apply (rule word_uint.Rep_eqD)

  apply (rule box_equals)

    defer

    apply (rule word_ubin.norm_Rep)+

  apply simp

  done

lemma uint_ge_0 [iff]: "0 \<le> uint (x::'a::len0 word)"

  using word_uint.Rep [of x] by (simp add: uints_num)

lemma uint_lt2p [iff]: "uint (x::'a::len0 word) < 2 ^ len_of TYPE('a)"

  using word_uint.Rep [of x] by (simp add: uints_num)

lemma sint_ge: "- (2 ^ (len_of TYPE('a) - 1)) \<le> sint (x::'a::len word)"

  using word_sint.Rep [of x] by (simp add: sints_num)

lemma sint_lt: "sint (x::'a::len word) < 2 ^ (len_of TYPE('a) - 1)"

  using word_sint.Rep [of x] by (simp add: sints_num)

lemma sign_uint_Pls [simp]: 

  "bin_sign (uint x) = 0"

  by (simp add: sign_Pls_ge_0)

lemma uint_m2p_neg: "uint (x::'a::len0 word) - 2 ^ len_of TYPE('a) < 0"

  by (simp only: diff_less_0_iff_less uint_lt2p)

lemma uint_m2p_not_non_neg:

  "\<not> 0 \<le> uint (x::'a::len0 word) - 2 ^ len_of TYPE('a)"

  by (simp only: not_le uint_m2p_neg)

lemma lt2p_lem:

  "len_of TYPE('a) \<le> n \<Longrightarrow> uint (w :: 'a::len0 word) < 2 ^ n"

  by (metis bintr_uint bintrunc_mod2p int_mod_lem zless2p)

lemma uint_le_0_iff [simp]: "uint x \<le> 0 \<longleftrightarrow> uint x = 0"

  by (fact uint_ge_0 [THEN leD, THEN linorder_antisym_conv1])

lemma uint_nat: "uint w = int (unat w)"

  unfolding unat_def by auto

lemma uint_numeral:

  "uint (numeral b :: 'a :: len0 word) = numeral b mod 2 ^ len_of TYPE('a)"

  unfolding word_numeral_alt

  by (simp only: int_word_uint)

lemma uint_neg_numeral:

  "uint (- numeral b :: 'a :: len0 word) = - numeral b mod 2 ^ len_of TYPE('a)"

  unfolding word_neg_numeral_alt

  by (simp only: int_word_uint)

lemma unat_numeral: 

  "unat (numeral b::'a::len0 word) = numeral b mod 2 ^ len_of TYPE ('a)"

  apply (unfold unat_def)

  apply (clarsimp simp only: uint_numeral)

  apply (rule nat_mod_distrib [THEN trans])

    apply (rule zero_le_numeral)

   apply (simp_all add: nat_power_eq)

  done

lemma sint_numeral: "sint (numeral b :: 'a :: len word) = (numeral b + 

    2 ^ (len_of TYPE('a) - 1)) mod 2 ^ len_of TYPE('a) -

    2 ^ (len_of TYPE('a) - 1)"

  unfolding word_numeral_alt by (rule int_word_sint)

lemma word_of_int_0 [simp, code_post]:

  "word_of_int 0 = 0"

  unfolding word_0_wi ..

lemma word_of_int_1 [simp, code_post]:

  "word_of_int 1 = 1"

  unfolding word_1_wi ..

lemma word_of_int_neg_1 [simp]: "word_of_int (- 1) = - 1"

  by (simp add: wi_hom_syms)

lemma word_of_int_numeral [simp] : 

  "(word_of_int (numeral bin) :: 'a :: len0 word) = (numeral bin)"

  unfolding word_numeral_alt ..

lemma word_of_int_neg_numeral [simp]:

  "(word_of_int (- numeral bin) :: 'a :: len0 word) = (- numeral bin)"

  unfolding word_numeral_alt wi_hom_syms ..

lemma word_int_case_wi: 

  "word_int_case f (word_of_int i :: 'b word) = 

    f (i mod 2 ^ len_of TYPE('b::len0))"

  unfolding word_int_case_def by (simp add: word_uint.eq_norm)

lemma word_int_split: 

  "P (word_int_case f x) = 

    (ALL i. x = (word_of_int i :: 'b :: len0 word) & 

      0 <= i & i < 2 ^ len_of TYPE('b) --> P (f i))"

  unfolding word_int_case_def

  by (auto simp: word_uint.eq_norm mod_pos_pos_trivial)

lemma word_int_split_asm: 

  "P (word_int_case f x) = 

    (~ (EX n. x = (word_of_int n :: 'b::len0 word) &

      0 <= n & n < 2 ^ len_of TYPE('b::len0) & ~ P (f n)))"

  unfolding word_int_case_def

  by (auto simp: word_uint.eq_norm mod_pos_pos_trivial)

lemmas uint_range' = word_uint.Rep [unfolded uints_num mem_Collect_eq]

lemmas sint_range' = word_sint.Rep [unfolded One_nat_def sints_num mem_Collect_eq]

lemma uint_range_size: "0 <= uint w & uint w < 2 ^ size w"

  unfolding word_size by (rule uint_range')

lemma sint_range_size:

  "- (2 ^ (size w - Suc 0)) <= sint w & sint w < 2 ^ (size w - Suc 0)"

  unfolding word_size by (rule sint_range')

lemma sint_above_size: "2 ^ (size (w::'a::len word) - 1) \<le> x \<Longrightarrow> sint w < x"

  unfolding word_size by (rule less_le_trans [OF sint_lt])

lemma sint_below_size:

  "x \<le> - (2 ^ (size (w::'a::len word) - 1)) \<Longrightarrow> x \<le> sint w"

  unfolding word_size by (rule order_trans [OF _ sint_ge])

subsection \<open>Testing bits\<close>

lemma test_bit_eq_iff: "(test_bit (u::'a::len0 word) = test_bit v) = (u = v)"

  unfolding word_test_bit_def by (simp add: bin_nth_eq_iff)

lemma test_bit_size [rule_format] : "(w::'a::len0 word) !! n --> n < size w"

  apply (unfold word_test_bit_def)

  apply (subst word_ubin.norm_Rep [symmetric])

  apply (simp only: nth_bintr word_size)

  apply fast

  done

lemma word_eq_iff:

  fixes x y :: "'a::len0 word"

  shows "x = y \<longleftrightarrow> (\<forall>n<len_of TYPE('a). x !! n = y !! n)"

  unfolding uint_inject [symmetric] bin_eq_iff word_test_bit_def [symmetric]

  by (metis test_bit_size [unfolded word_size])

lemma word_eqI [rule_format]:

  fixes u :: "'a::len0 word"

  shows "(ALL n. n < size u --> u !! n = v !! n) \<Longrightarrow> u = v"

  by (simp add: word_size word_eq_iff)

lemma word_eqD: "(u::'a::len0 word) = v \<Longrightarrow> u !! x = v !! x"

  by simp

lemma test_bit_bin': "w !! n = (n < size w & bin_nth (uint w) n)"

  unfolding word_test_bit_def word_size

  by (simp add: nth_bintr [symmetric])

lemmas test_bit_bin = test_bit_bin' [unfolded word_size]

lemma bin_nth_uint_imp:

  "bin_nth (uint (w::'a::len0 word)) n \<Longrightarrow> n < len_of TYPE('a)"

  apply (rule nth_bintr [THEN iffD1, THEN conjunct1])

  apply (subst word_ubin.norm_Rep)

  apply assumption

  done

lemma bin_nth_sint:

  fixes w :: "'a::len word"

  shows "len_of TYPE('a) \<le> n \<Longrightarrow>

    bin_nth (sint w) n = bin_nth (sint w) (len_of TYPE('a) - 1)"

  apply (subst word_sbin.norm_Rep [symmetric])

  apply (auto simp add: nth_sbintr)

  done

(* type definitions theorem for in terms of equivalent bool list *)

lemma td_bl: 

  "type_definition (to_bl :: 'a::len0 word => bool list) 

                   of_bl  

                   {bl. length bl = len_of TYPE('a)}"

  apply (unfold type_definition_def of_bl_def to_bl_def)

  apply (simp add: word_ubin.eq_norm)

  apply safe

  apply (drule sym)

  apply simp

  done

interpretation word_bl:

  type_definition "to_bl :: 'a::len0 word => bool list"

                  of_bl  

                  "{bl. length bl = len_of TYPE('a::len0)}"

  by (fact td_bl)

lemmas word_bl_Rep' = word_bl.Rep [unfolded mem_Collect_eq, iff]

lemma word_size_bl: "size w = size (to_bl w)"

  unfolding word_size by auto

lemma to_bl_use_of_bl:

  "(to_bl w = bl) = (w = of_bl bl \<and> length bl = length (to_bl w))"

  by (fastforce elim!: word_bl.Abs_inverse [unfolded mem_Collect_eq])

lemma to_bl_word_rev: "to_bl (word_reverse w) = rev (to_bl w)"

  unfolding word_reverse_def by (simp add: word_bl.Abs_inverse)

lemma word_rev_rev [simp] : "word_reverse (word_reverse w) = w"

  unfolding word_reverse_def by (simp add : word_bl.Abs_inverse)

lemma word_rev_gal: "word_reverse w = u \<Longrightarrow> word_reverse u = w"

  by (metis word_rev_rev)

lemma word_rev_gal': "u = word_reverse w \<Longrightarrow> w = word_reverse u"

  by simp

lemma length_bl_gt_0 [iff]: "0 < length (to_bl (x::'a::len word))"

  unfolding word_bl_Rep' by (rule len_gt_0)

lemma bl_not_Nil [iff]: "to_bl (x::'a::len word) \<noteq> []"

  by (fact length_bl_gt_0 [unfolded length_greater_0_conv])

lemma length_bl_neq_0 [iff]: "length (to_bl (x::'a::len word)) \<noteq> 0"

  by (fact length_bl_gt_0 [THEN gr_implies_not0])

lemma hd_bl_sign_sint: "hd (to_bl w) = (bin_sign (sint w) = -1)"

  apply (unfold to_bl_def sint_uint)

  apply (rule trans [OF _ bl_sbin_sign])

  apply simp

  done

lemma of_bl_drop': 

  "lend = length bl - len_of TYPE ('a :: len0) \<Longrightarrow> 

    of_bl (drop lend bl) = (of_bl bl :: 'a word)"

  apply (unfold of_bl_def)

  apply (clarsimp simp add : trunc_bl2bin [symmetric])

  done

lemma test_bit_of_bl:  

  "(of_bl bl::'a::len0 word) !! n = (rev bl ! n \<and> n < len_of TYPE('a) \<and> n < length bl)"

  apply (unfold of_bl_def word_test_bit_def)

  apply (auto simp add: word_size word_ubin.eq_norm nth_bintr bin_nth_of_bl)

  done

lemma no_of_bl: 

  "(numeral bin ::'a::len0 word) = of_bl (bin_to_bl (len_of TYPE ('a)) (numeral bin))"

  unfolding of_bl_def by simp

lemma uint_bl: "to_bl w = bin_to_bl (size w) (uint w)"

  unfolding word_size to_bl_def by auto

lemma to_bl_bin: "bl_to_bin (to_bl w) = uint w"

  unfolding uint_bl by (simp add : word_size)

lemma to_bl_of_bin: 

  "to_bl (word_of_int bin::'a::len0 word) = bin_to_bl (len_of TYPE('a)) bin"

  unfolding uint_bl by (clarsimp simp add: word_ubin.eq_norm word_size)

lemma to_bl_numeral [simp]:

  "to_bl (numeral bin::'a::len0 word) =

    bin_to_bl (len_of TYPE('a)) (numeral bin)"

  unfolding word_numeral_alt by (rule to_bl_of_bin)

lemma to_bl_neg_numeral [simp]:

  "to_bl (- numeral bin::'a::len0 word) =

    bin_to_bl (len_of TYPE('a)) (- numeral bin)"

  unfolding word_neg_numeral_alt by (rule to_bl_of_bin)

lemma to_bl_to_bin [simp] : "bl_to_bin (to_bl w) = uint w"

  unfolding uint_bl by (simp add : word_size)

lemma uint_bl_bin:

  fixes x :: "'a::len0 word"

  shows "bl_to_bin (bin_to_bl (len_of TYPE('a)) (uint x)) = uint x"

  by (rule trans [OF bin_bl_bin word_ubin.norm_Rep])

(* naturals *)

lemma uints_unats: "uints n = int ` unats n"

  apply (unfold unats_def uints_num)

  apply safe

  apply (rule_tac image_eqI)

  apply (erule_tac nat_0_le [symmetric])

  apply auto

  apply (erule_tac nat_less_iff [THEN iffD2])

  apply (rule_tac [2] zless_nat_eq_int_zless [THEN iffD1])

  apply (auto simp add : nat_power_eq of_nat_power)

  done

lemma unats_uints: "unats n = nat ` uints n"

  by (auto simp add : uints_unats image_iff)

lemmas bintr_num = word_ubin.norm_eq_iff

  [of "numeral a" "numeral b", symmetric, folded word_numeral_alt] for a b

lemmas sbintr_num = word_sbin.norm_eq_iff

  [of "numeral a" "numeral b", symmetric, folded word_numeral_alt] for a b

lemma num_of_bintr':

  "bintrunc (len_of TYPE('a :: len0)) (numeral a) = (numeral b) \<Longrightarrow> 

    numeral a = (numeral b :: 'a word)"

  unfolding bintr_num by (erule subst, simp)

lemma num_of_sbintr':

  "sbintrunc (len_of TYPE('a :: len) - 1) (numeral a) = (numeral b) \<Longrightarrow> 

    numeral a = (numeral b :: 'a word)"

  unfolding sbintr_num by (erule subst, simp)

lemma num_abs_bintr:

  "(numeral x :: 'a word) =

    word_of_int (bintrunc (len_of TYPE('a::len0)) (numeral x))"

  by (simp only: word_ubin.Abs_norm word_numeral_alt)

lemma num_abs_sbintr:

  "(numeral x :: 'a word) =

    word_of_int (sbintrunc (len_of TYPE('a::len) - 1) (numeral x))"

  by (simp only: word_sbin.Abs_norm word_numeral_alt)

(** cast - note, no arg for new length, as it's determined by type of result,