text:
#include "tensorflow/compiler/xla/service/hlo_input_output_alias_config.h"

#include <memory>
#include <string>

#include "absl/algorithm/container.h"
#include "tensorflow/compiler/xla/service/hlo_computation.h"
#include "tensorflow/compiler/xla/service/hlo_dce.h"
#include "tensorflow/compiler/xla/service/hlo_instruction.h"
#include "tensorflow/compiler/xla/service/hlo_memory_scheduler.h"
#include "tensorflow/compiler/xla/service/hlo_opcode.h"
#include "tensorflow/compiler/xla/service/hlo_ordering.h"
#include "tensorflow/compiler/xla/shape_util.h"
#include "tensorflow/compiler/xla/tests/hlo_test_base.h"
#include "tensorflow/compiler/xla/types.h"
#include "tensorflow/core/lib/core/status_test_util.h"

namespace xla {
namespace {
class HloInputOutputAliasConfigTest : public HloTestBase {
 protected:
  void expect_aliased(const ShapeIndex& output_index, int64 param_number,
                      const ShapeIndex& param_index,
                      const HloInputOutputAliasConfig& config) {
    absl::optional<ShapeIndex> aliased_output =
        config.GetAliasedOutput(param_number, param_index);

    EXPECT_TRUE(aliased_output);
    EXPECT_EQ(aliased_output.value(), output_index);

    absl::optional<HloInputOutputAliasConfig::Alias> aliased_param =
        config.GetAliasedParameter(output_index);

    EXPECT_TRUE(aliased_param);
    EXPECT_EQ(aliased_param->parameter_number, param_number);
    EXPECT_EQ(aliased_param->parameter_index, param_index);
  }

  void expect_not_aliased(const ShapeIndex& output_index, int64 param_number,
                          const ShapeIndex& param_index,
                          const HloInputOutputAliasConfig& config) {
    absl::optional<ShapeIndex> aliased_output =
        config.GetAliasedOutput(param_number, param_index);

    EXPECT_FALSE(aliased_output && aliased_output == output_index);

    absl::optional<HloInputOutputAliasConfig::Alias> aliased_param =
        config.GetAliasedParameter(output_index);

    EXPECT_FALSE(aliased_param &&
                 aliased_param->parameter_number == param_number &&
                 aliased_param->parameter_index == param_index);
  }
};

TEST_F(HloInputOutputAliasConfigTest, SimpleAliasing) {
  const string module_str = R"(
HloModule TEST

ENTRY main {
  a = f32[] parameter(0)
  b = f32[] parameter(1)
  ROOT root = (f32[], f32[]) tuple(%a, %b)
}
)";
  TF_ASSERT_OK_AND_ASSIGN(std::unique_ptr<HloModule> module,
                          ParseAndReturnVerifiedModule(module_str));

  HloInputOutputAliasConfig config(
      module->entry_computation()->root_instruction()->shape());

  TF_ASSERT_OK(config.SetUpAlias(
      /*output_index=*/{0}, /*param_number=*/1,
      /*param_index=*/{},
      /*kind=*/HloInputOutputAliasConfig::AliasKind::kUserAlias));

  expect_aliased(/*output_index=*/{0}, /*param_number=*/1,
                 /*param_index=*/{}, config);

  expect_not_aliased(/*output_index=*/{1}, /*param_number=*/1,
                     /*param_index=*/{}, config);

  expect_not_aliased(/*output_index=*/{0}, /*param_number=*/0,
                     /*param_index=*/{}, config);
}

TEST_F(HloInputOutputAliasConfigTest, SimpleAliasingWithTupleInput) {
  const string module_str = R"(
HloModule TEST

ENTRY main {
  param = (f32[], f32[]) parameter(0)
  gte1 = f32[] get-tuple-element(%param), index=0
  gte2 = f32[] get-tuple-element(%param), index=1
  ROOT root = (f32[], f32[]) tuple(%gte1, %gte2)
}
)";
  TF_ASSERT_OK_AND_ASSIGN(std::unique_ptr<HloModule> module,
                          ParseAndReturnVerifiedModule(module_str));

  HloInputOutputAliasConfig config(
      module->entry_computation()->root_instruction()->shape());

  TF_ASSERT_OK(config.SetUpAlias(
      /*output_index=*/{0}, /*param_number=*/0,
      /*param_index=*/{0},
      /*kind=*/HloInputOutputAliasConfig::AliasKind::kUserAlias));

  TF_ASSERT_OK(config.SetUpAlias(
      /*output_index=*/{1}, /*param_number=*/0,
      /*param_index=*/{1},
      /*kind=*/HloInputOutputAliasConfig::AliasKind::kUserAlias));

  expect_aliased(/*output_index=*/{0}, /*param_number=*/0,
                 /*param_index=*/{0}, config);

  expect_aliased(/*output_index=*/{1}, /*param_number=*/0,
                 /*param_index=*/{1}, config);

  expect_not_aliased(/*output_index=*/{1}, /*param_number=*/1,
                     /*param_index=*/{}, config);

  expect_not_aliased(/*output_index=*/{0}, /*param_number=*/0,
                     /*param_index=*/{}, config);
}

TEST_F(HloInputOutputAliasConfigTest, InputDoNotAliasTwice) {
  const string module_str = R"(
HloModule TEST

ENTRY main {
  a = f32[] parameter(0)
  b = f32[] parameter(1)
  ROOT root = (f32[], f32[]) tuple(%a, %b)
}
)";
  TF_ASSERT_OK_AND_ASSIGN(std::unique_ptr<HloModule> module,
                          ParseAndReturnVerifiedModule(module_str));

  HloInputOutputAliasConfig config(
      module->entry_computation()->root_instruction()->shape());

  TF_ASSERT_OK(config.SetUpAlias(
      /*output_index=*/{0}, /*param_number=*/0,
      /*param_index=*/{},
      /*kind=*/HloInputOutputAliasConfig::AliasKind::kUserAlias));

  TF_ASSERT_OK(config.SetUpAlias(
      /*output_index=*/{1}, /*param_number=*/0,
      /*param_index=*/{},
      /*kind=*/HloInputOutputAliasConfig::AliasKind::kUserAlias));

  ASSERT_IS_NOT_OK(config.Verify(*module, [](const Shape& shape) {
    return ShapeUtil::ByteSizeOf(shape);
  }));
}

TEST_F(HloInputOutputAliasConfigTest, SizesMustMatch) {
  const string module_str = R"(
HloModule TEST

ENTRY main {
  a = f32[] parameter(0)
  b = f32[4096] parameter(1)
  ROOT root = (f32[], f32[4096]) tuple(%a, %b)
}
)";
  TF_ASSERT_OK_AND_ASSIGN(std::unique_ptr<HloModule> module,
                          ParseAndReturnVerifiedModule(module_str));

  HloInputOutputAliasConfig config(
      module->entry_computation()->root_instruction()->shape());

  TF_ASSERT_OK(config.SetUpAlias(
      /*output_index=*/{1}, /*param_number=*/0,
      /*param_index=*/{},
      /*kind=*/HloInputOutputAliasConfig::AliasKind::kUserAlias));

  ASSERT_IS_NOT_OK(config.Verify(*module, [](const Shape& shape) {
    return ShapeUtil::ByteSizeOf(shape);
  }));
}

TEST_F(HloInputOutputAliasConfigTest, OutputDoNotAliasTwice) {
  const string module_str = R"(
HloModule TEST

ENTRY main {
  a = f32[] parameter(0)
  b = f32[] parameter(1)
  ROOT root = (f32[], f32[]) tuple(%a, %b)
}
)";
  TF_ASSERT_OK_AND_ASSIGN(std::unique_ptr<HloModule> module,
                          ParseAndReturnVerifiedModule(module_str));

  HloInputOutputAliasConfig config(
      module->entry_computation()->root_instruction()->shape());

  TF_ASSERT_OK(config.SetUpAlias(
      /*output_index=*/{0}, /*param_number=*/0,
      /*param_index=*/{},
      /*kind=*/HloInputOutputAliasConfig::AliasKind::kUserAlias));

  ASSERT_IS_NOT_OK(config.SetUpAlias(
      /*output_index=*/{0}, /*param_number=*/1,
      /*param_index=*/{},
      /*kind=*/HloInputOutputAliasConfig::AliasKind::kUserAlias));
}
}  // namespace
}  // namespace xla


text:
/* LibTomCrypt, modular cryptographic library -- Tom St Denis
 *
 * LibTomCrypt is a library that provides various cryptographic
 * algorithms in a highly modular and flexible manner.
 *
 * The library is free for all purposes without any express
 * guarantee it works.
 */
#include "tomcrypt_private.h"

/**
  @file der_length_utctime.c
  ASN.1 DER, get length of UTCTIME, Tom St Denis
*/

#ifdef LTC_DER

/**
  Gets length of DER encoding of UTCTIME
  @param utctime      The UTC time structure to get the size of
  @param outlen [out] The length of the DER encoding
  @return CRYPT_OK if successful
*/
int der_length_utctime(const ltc_utctime *utctime, unsigned long *outlen)
{
   LTC_ARGCHK(outlen  != NULL);
   LTC_ARGCHK(utctime != NULL);

   if (utctime->off_hh == 0 && utctime->off_mm == 0) {
      /* we encode as YYMMDDhhmmssZ */
      *outlen = 2 + 13;
   } else {
      /* we encode as YYMMDDhhmmss{+|-}hh'mm' */
      *outlen = 2 + 17;
   }

   return CRYPT_OK;
}

#endif

/* ref:         HEAD -> develop */
/* git commit:  9c0d7085234bd6baba2ab8fd9eee62254599341c */
/* commit time: 2018-10-15 10:51:17 +0200 */

redpajama_set_name: RedPajamaGithub


text:
import numpy as np

from activations import get_activation
from initializations import get_initialization
import env
from utils import RNG

# TODO: implement `get_layer` function

class BaseLayer(object):
    def __init__(self, random_seed=None, **params):
        self.random_seed = random_seed

    def setup_weights(self, x_shape):
        pass

    def forward_pass(self, x):
        raise NotImplementedError()

    def backward_pass(self, residual):
        raise NotImplementedError()

    def shape(self, prev_shape):
        return prev_shape

    def _serialize(self):
        return {}

    @property
    def n_params(self):
        return 0

class FullyConnected(BaseLayer):
    """
    Examples
    --------
    >>> fc = FullyConnected(10)
    >>> fc.setup_weights(x_shape=(128, 32)) # (batch_size, n_features)
    >>> fc.W.shape
    (32, 10)
    >>> fc.b.shape
    (10,)
    >>> fc.n_params # size of W + size of b
    330
    """
    def __init__(self, output_dim, bias=1.0, init='glorot_uniform', L1=0.0, L2=0.0, max_norm=-1, **params):
        self.output_dim = output_dim
        self.bias = bias
        self.init_name = init
        self.init = get_initialization(init)
        self.L1 = L1
        self.L2 = L2
        self.max_norm = max_norm
        self.W = np.array([]) # weights will be updated by optimizer
        self.b = np.array([])
        self.dW = np.array([]) # dW, db will be used by optimizer
        self.db = np.array([])
        self._last_input = None
        super(FullyConnected, self).__init__(**params)

    def _max_norm_update(self):
        L = np.linalg.norm(self.W, np.inf)
        if L > self.max_norm > 0:
            self.W *= self.max_norm / L

    def setup_weights(self, x_shape):
        self.W = self.init(shape=(x_shape[1], self.output_dim), random_seed=self.random_seed)
        self.b = np.full(self.W.shape[1], self.bias)

    def forward_pass(self, x):
        self._last_input = x
        return np.dot(x, self.W) + self.b

    def backward_pass(self, residual):
        self.dW = np.dot(self._last_input.T, residual) + self.L2 * self.W + self.L1 * np.sign(self.W)
        self.db = np.sum(residual, axis=0)
        return np.dot(residual, self.W.T)

    def shape(self, prev_shape):
        return prev_shape[1], self.output_dim

    @property
    def n_params(self):
        return np.size(self.W) + np.size(self.b)

    def _serialize(self):
        return dict(
            layer='fully_connected',
            random_seed=self.random_seed,
            output_dim=self.output_dim,
            bias=self.bias,
            init=self.init_name,
            L1=self.L1,
            L2=self.L2,
            max_norm=self.max_norm,
            W=self.W.tolist(),
            b=self.b.tolist(),
            dW=self.dW.tolist(),
            db=self.db.tolist(),
        )

class Activation(BaseLayer):
    def __init__(self, activation, **params):
        self.activation_name = activation
        self.activation = get_activation(self.activation_name)
        self._last_input = None
        super(Activation, self).__init__(**params)

    def forward_pass(self, x):
        self._last_input = x
        return self.activation(x)

    def backward_pass(self, residual):
        return self.activation(self._last_input, derivative=True) * residual

    def _serialize(self):
        return dict(
            layer='activation',
            random_seed=self.random_seed,
            activation=self.activation_name,
        )

class Dropout(BaseLayer):
    """
    Randomly set a fraction of `p` inputs to 0
    at each training update.
    """
    def __init__(self, p=0.2, **params):
        self.p = p
        self.is_training = False
        self._mask = None
        super(Dropout, self).__init__(**params)

    def forward_pass(self, X):
        # assert self.p > 0
        if self.is_training:
            self._mask = RNG(self.random_seed).uniform(size=X.shape) > self.p
            Z = self._mask * X
        else:
            Z = (1.0 - self.p) * X # to keep output of the same scale (on average)
        return Z

    def backward_pass(self, residual):
        return self._mask * residual

    def _serialize(self):
        return dict(
            layer='dropout',
            random_seed=self.random_seed,
            p=self.p,
        )

# aliases
Dense = FullyConnected

if __name__ == '__main__':
    # run corresponding tests
    import env
    from utils.testing import run_tests
    run_tests(__file__)


text:
<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://github.com/TreetonOrg/Treeton" xsi:schemaLocation="https://github.com/TreetonOrg/Treeton https://github.com/TreetonOrg/Treeton/contextSchema.xsd">
    <DOMAIN NAME="Common" DIR="./Common/" SHORTNAME="">
        <TYPESDCL>./types.dcl</TYPESDCL>
        <RELSXML>./relations.xml</RELSXML>

        <RESOURCETYPE NAME="Cleanup">
            <CLASS>treeton.res.CleanUp</CLASS>
        </RESOURCETYPE>

        <RESOURCETYPE NAME="Tokeniser">
            <CLASS>treeton.res.tokeniser.SimpleTokeniser</CLASS>
            <PARAMDESCRIPTION NAME="rulesPath" TYPE="String"/>
            <PARAMDESCRIPTION NAME="errorMatchesPath" TYPE="String"/>
            <PARAMDESCRIPTION NAME="atomicType" TYPE="String"/>
            <PARAMDESCRIPTION NAME="defaultTokenType" TYPE="String"/>
            <PARAMDESCRIPTION NAME="kindFeature" TYPE="String"/>
            <PARAMDESCRIPTION NAME="langFeature" TYPE="String"/>
        </RESOURCETYPE>

        <RESOURCETYPE NAME="Minimizator">
            <CLASS>treeton.res.minimz.Minimizator</CLASS>
            <PARAMDESCRIPTION NAME="rulesPath" TYPE="String"/>
        </RESOURCETYPE>

        <RESOURCETYPE NAME="ScapeTransducer">
            <CLASS>treeton.res.ScapeTransducer</CLASS>
            <PARAMDESCRIPTION NAME="rulesPath" TYPE="String"/>
            <PARAMDESCRIPTION NAME="mainProgram" TYPE="String"/>
        </RESOURCETYPE>

        <RESOURCETYPE NAME="VNPExtractor">
            <CLASS>treeton.res.ru.extraction.VNPExtraction</CLASS>
        </RESOURCETYPE>

        <RESOURCETYPE NAME="VNPExtractor2">
            <CLASS>treeton.res.ru.extraction.NewExtraction</CLASS>
        </RESOURCETYPE>

        <RESOURCETYPE NAME="TrainingData">
            <CLASS>treeton.res.ru.extraction.TrainingData</CLASS>
        </RESOURCETYPE>

        <RESOURCETYPE NAME="PrepAttachment">
            <CLASS>treeton.res.ru.extraction.PrepAttachment</CLASS>
        </RESOURCETYPE>

        <RESOURCE NAME="Common_Cleanup" TYPE="Cleanup"/>

        <DOMAIN NAME="Russian" DIR="./Russian/" SHORTNAME="R">
            <TYPESDCL>./types.dcl</TYPESDCL>
            <RELSXML>./relations.xml</RELSXML>

            <SYNTAX_RULES NAME="ShallowSyntax">
                <RULESPATH>./syntax/syntaxRuShallow.xml</RULESPATH>
            </SYNTAX_RULES>

            <SYNTAX_PENALTIES NAME="ShallowSyntaxPenalties">
                <RULESPATH>./syntax/penaltiesRuShallow.xml</RULESPATH>
            </SYNTAX_PENALTIES>

            <RESOURCETYPE NAME="UncoveredTrnsGenerator">
                <CLASS>treeton.res.UncoveredTrnsProcessor</CLASS>
                <PARAMDESCRIPTION NAME="coverTypes" TYPE="String" MANYVALUED="true"/>
                <PARAMDESCRIPTION NAME="inputTemplate" TYPE="String"/>
                <PARAMDESCRIPTION NAME="assignments" TYPE="String"/>
            </RESOURCETYPE>

            <RESOURCETYPE NAME="TrnMapper">
                <CLASS>treeton.res.TrnMapper</CLASS>
                <PARAMDESCRIPTION NAME="path" TYPE="String"/>
            </RESOURCETYPE>

            <RESOURCETYPE NAME="NumbersProcessor">
                <CLASS>treeton.res.ru.NumbersProcessor</CLASS>
                <PARAMDESCRIPTION NAME="propertiesURL" TYPE="String"/>
                <PARAMDESCRIPTION NAME="templatesPhase" TYPE="String"/>
                <PARAMDESCRIPTION NAME="Morph_type" TYPE="String"/>
            </RESOURCETYPE>

            <RESOURCETYPE NAME="InvarsConverter">
                <CLASS>treeton.res.InvarsConverter</CLASS>
                <PARAMDESCRIPTION NAME="inputType" TYPE="String"/>
            </RESOURCETYPE>

            <RESOURCETYPE NAME="GovModelMultiplier">
                <CLASS>treeton.res.government.GovModelMultiplier</CLASS>
                <PARAMDESCRIPTION NAME="inputType" TYPE="String"/>
                <PARAMDESCRIPTION NAME="GovDictionary" TYPE="String"/>
                <PARAMDESCRIPTION NAME="semFeatureName" TYPE="String"/>
                <PARAMDESCRIPTION NAME="govIDFeatureName" TYPE="String"/>
                <PARAMDESCRIPTION NAME="govFeatureName" TYPE="String"/>
            </RESOURCETYPE>

            <RESOURCETYPE NAME="UnknownMorphFsmApplier">
                <CLASS>treeton.res.ru.unknown.RuUnknownMorphFsmApplierResource</CLASS>
                <PARAMDESCRIPTION NAME="uncoveredAreasOnly" TYPE="Boolean" OPTIONAL="true"/>
                <PARAMDESCRIPTION NAME="path" TYPE="String"/>
                <PARAMDESCRIPTION NAME="Tokeniser_resourceType" TYPE="String"/>
                <PARAMDESCRIPTION NAME="predMorphPhaseTemplate" TYPE="String"/>
            </RESOURCETYPE>

            <RESOURCETYPE NAME="RusMorphDictsApplier">
                <CLASS>treeton.res.ru.RusMorphApplierResource</CLASS>
                <PARAMDESCRIPTION NAME="uncoveredAreasOnly" TYPE="Boolean" OPTIONAL="true"/>
                <PARAMDESCRIPTION NAME="path" TYPE="String"/>
                <PARAMDESCRIPTION NAME="Tokeniser_resourceType" TYPE="String"/>
            </RESOURCETYPE>

            <RESOURCETYPE NAME="RusFreqDictApplier">
                <CLASS>treeton.res.ru.frequency.FreqDictApplierResource</CLASS>
                <PARAMDESCRIPTION NAME="path" TYPE="String"/>
                <PARAMDESCRIPTION NAME="Morph_type" TYPE="String"/>
            </RESOURCETYPE>

            <RESOURCETYPE NAME="StarlingMorphApplier">
                <CLASS>treeton.res.ru.StarlingMorphApplier</CLASS>

                <!-- native engine will be used if absent -->
                <PARAMDESCRIPTION NAME="port" TYPE="Integer" OPTIONAL="true"/>

                <PARAMDESCRIPTION NAME="conversionLexRules" TYPE="String"/>
                <PARAMDESCRIPTION NAME="conversionInflRules" TYPE="String"/>
                <PARAMDESCRIPTION NAME="nativeMorphDictPath" TYPE="String" OPTIONAL="true"/>
                <PARAMDESCRIPTION NAME="targetType" TYPE="String"/>
                <PARAMDESCRIPTION NAME="predMorphPhase" TYPE="String"/>
                <PARAMDESCRIPTION NAME="logging" TYPE="Boolean"  OPTIONAL="true"/>
                <PARAMDESCRIPTION NAME="specialWords" TYPE="String"/>
            </RESOURCETYPE>

            <RESOURCETYPE NAME="StarlingOnlyAccentMorphApplier">
                <CLASS>treeton.res.ru.StarlingOnlyAccentMorphApplier</CLASS>

                <PARAMDESCRIPTION NAME="targetType" TYPE="String"/>
                <PARAMDESCRIPTION NAME="bagOfWordsPath" TYPE="String" OPTIONAL="true"/>
                <PARAMDESCRIPTION NAME="predMorphPhase" TYPE="String"/>
                <PARAMDESCRIPTION NAME="specialAccents" TYPE="String"/>
                <PARAMDESCRIPTION NAME="specialWords" TYPE="String"/>
            </RESOURCETYPE>

            <RESOURCETYPE NAME="Syllabizator">
                <CLASS>treeton.res.ru.Syllabizator</CLASS>
                <PARAMDESCRIPTION NAME="targetType" TYPE="String"/>
                <PARAMDESCRIPTION NAME="inputTemplate" TYPE="String"/>
            </RESOURCETYPE>

            <RESOURCETYPE NAME="AccentGenerator">
                <CLASS>treeton.res.ru.AccentGenerator</CLASS>
                <PARAMDESCRIPTION NAME="Morph_type" TYPE="String"/>
                <PARAMDESCRIPTION NAME="ACCPL_feature" TYPE="String"/>
                <PARAMDESCRIPTION NAME="POS_feature" TYPE="String"/>
                <PARAMDESCRIPTION NAME="Klitik_feature" TYPE="String"/>
                <PARAMDESCRIPTION NAME="AccVariant_type" TYPE="String"/>
                <PARAMDESCRIPTION NAME="MorphArr_feature" TYPE="String"/>
                <PARAMDESCRIPTION NAME="Syllable_type" TYPE="String"/>
                <PARAMDESCRIPTION NAME="PhonWord_type" TYPE="String"/>
                <PARAMDESCRIPTION NAME="klitik_POSes" TYPE="String" MANYVALUED="true" OPTIONAL="true"/>
            </RESOURCETYPE>

            <RESOURCE NAME="Russian_Tokeniser" TYPE="Tokeniser">
                <PARAM NAME="rulesPath">
                    <VALUE>./resources/tokeniser/DefaultTokeniser.rules</VALUE>
                </PARAM>
                <PARAM NAME="errorMatchesPath">
                    <VALUE>./resources/tokeniser/eng-rus_error_matches.txt</VALUE>
                </PARAM>
                <PARAM NAME="atomicType">
                    <VALUE>Atom</VALUE>
                </PARAM>
                <PARAM NAME="defaultTokenType">
                    <VALUE>DEFAULT_TOKEN</VALUE>
                </PARAM>
                <PARAM NAME="kindFeature">
                    <VALUE>kind</VALUE>
                </PARAM>
                <PARAM NAME="langFeature">
                    <VALUE>lang</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_CommaProcessor" TYPE="ScapeTransducer">
                <PARAM NAME="rulesPath">
                    <VALUE>./resources/morph/punct/</VALUE>
                </PARAM>
                <PARAM NAME="mainProgram">
                    <VALUE>russian.morph.punct.Main</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_UnknownMorphGenerator" TYPE="UncoveredTrnsGenerator">
                <COMMENT>Russian UnknownMorphGenerator</COMMENT>
                <PARAM NAME="inputTemplate">
                    <VALUE>{Token: kind=word,lang=cyr}</VALUE>
                </PARAM>
                <PARAM NAME="assignments">
                    <VALUE>Gramm(WORDFORM:=@.string;orth:=@.orth;kind:=@.kind;lang:=@.lang;TYPE:=unknown;)</VALUE>
                </PARAM>
                <PARAM NAME="coverTypes">
                    <VALUE>Gramm</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_NumbersProcessor" TYPE="NumbersProcessor">
                <COMMENT>Russian NumbersProcessor</COMMENT>
                <PARAM NAME="propertiesURL">
                    <VALUE>./resources/morph/procnum.properties</VALUE>
                </PARAM>
                <PARAM NAME="Morph_type">
                    <VALUE>Gramm</VALUE>
                </PARAM>
                <PARAM NAME="templatesPhase">
                    <VALUE>./resources/morph/procnum/templates.scape</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_MorphMinimizator" TYPE="Minimizator">
                <COMMENT>Russian Morphological Minimization Utility</COMMENT>
                <PARAM NAME="rulesPath">
                    <VALUE>./resources/morph/MinimzMorph.java</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_MorphInvarsConverter" TYPE="InvarsConverter">
                <COMMENT>Russian Morph Invars Converter</COMMENT>
                <PARAM NAME="inputType">
                    <VALUE>Gramm</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_MorphGovModelMultiplier" TYPE="GovModelMultiplier">
                <COMMENT>Russian Morph Gov Mapper</COMMENT>
                <PARAM NAME="inputType">
                    <VALUE>Gramm</VALUE>
                </PARAM>
                <PARAM NAME="GovDictionary">
                    <VALUE>treeton.dictanalyzer.govdictloader.govonto.GovDictionaryOntoImpl</VALUE>
                </PARAM>
                <PARAM NAME="semFeatureName">
                    <VALUE>SEM</VALUE>
                </PARAM>
                <PARAM NAME="govFeatureName">
                    <VALUE>GOV</VALUE>
                </PARAM>
                <PARAM NAME="govIDFeatureName">
                    <VALUE>GOVID</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_UnknownMorphFsmApplier" TYPE="UnknownMorphFsmApplier">
                <PARAM NAME="path">
                    <VALUE>./resources/morph/zaliz.dct</VALUE>
                </PARAM>
                <PARAM NAME="Tokeniser_resourceType">
                    <VALUE>Tokeniser</VALUE>
                </PARAM>
                <PARAM NAME="predMorphPhaseTemplate">
                    <VALUE>({Token:kind=word}{Token:}*)?{Gramm:TYPE=unknown}</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_ZalizApplier" TYPE="RusMorphDictsApplier">
                <PARAM NAME="path">
                    <VALUE>./resources/morph/zaliz.dct</VALUE>
                </PARAM>
                <PARAM NAME="Tokeniser_resourceType">
                    <VALUE>Tokeniser</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_FreqDictApplier" TYPE="RusFreqDictApplier">
                <PARAM NAME="path">
                    <VALUE>./resources/morph/freq/freq_dict.txt</VALUE>
                </PARAM>
                <PARAM NAME="Morph_type">
                    <VALUE>Gramm</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_VNPExtractor" TYPE="VNPExtractor">
            </RESOURCE>

            <RESOURCE NAME="Russian_VNPExtractor2" TYPE="VNPExtractor2">
            </RESOURCE>

            <RESOURCE NAME="Russian_TrainingData" TYPE="TrainingData">
            </RESOURCE>

            <RESOURCE NAME="Russian_PrepAttachment" TYPE="PrepAttachment">
            </RESOURCE>

            <RESOURCE NAME="Russian_StarlingMorphApplier" TYPE="StarlingMorphApplier">
                <PARAM NAME="port">
                    <VALUE>8001</VALUE>
                </PARAM>
                <PARAM NAME="conversionLexRules">
                    <VALUE>./resources/starlingMorph/conversionLex.map</VALUE>
                </PARAM>
                <PARAM NAME="conversionInflRules">
                    <VALUE>./resources/starlingMorph/conversionInfl.map</VALUE>
                </PARAM>
                <PARAM NAME="targetType">
                    <VALUE>Gramm</VALUE>
                </PARAM>
                <PARAM NAME="predMorphPhase">
                    <VALUE>./resources/starlingMorph/PredMorph.scape</VALUE>
                </PARAM>
                <PARAM NAME="specialWords">
                    <VALUE>./resources/starlingMorph/specialWords.dct</VALUE>
                </PARAM>
                <PARAM NAME="logging">
                    <VALUE>true</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_StarlingOnlyAccentMorphApplier" TYPE="StarlingOnlyAccentMorphApplier">
                <PARAM NAME="targetType">
                    <VALUE>Gramm</VALUE>
                </PARAM>
                <PARAM NAME="bagOfWordsPath">
                    <VALUE>./resources/starlingMorph/accentsBag.bin</VALUE>
                </PARAM>
                <PARAM NAME="predMorphPhase">
                    <VALUE>./resources/starlingMorph/PredMorph.scape</VALUE>
                </PARAM>
                <PARAM NAME="specialAccents">
                    <VALUE>./resources/starlingMorph/specialAccents.dct</VALUE>
                </PARAM>
                <PARAM NAME="specialWords">
                    <VALUE>./resources/starlingMorph/specialWords.dct</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_StarlingNativeMorphApplier" TYPE="StarlingMorphApplier">
                <PARAM NAME="conversionLexRules">
                    <VALUE>./resources/starlingMorph/conversionLex.map</VALUE>
                </PARAM>
                <PARAM NAME="conversionInflRules">
                    <VALUE>./resources/starlingMorph/conversionInfl.map</VALUE>
                </PARAM>
                <PARAM NAME="nativeMorphDictPath">
                    <VALUE>./resources/starlingMorph/dict_ru.dct</VALUE>
                </PARAM>
                <PARAM NAME="targetType">
                    <VALUE>Gramm</VALUE>
                </PARAM>
                <PARAM NAME="predMorphPhase">
                    <VALUE>./resources/starlingMorph/PredMorph.scape</VALUE>
                </PARAM>
                <PARAM NAME="specialWords">
                    <VALUE>./resources/starlingMorph/specialWords.dct</VALUE>
                </PARAM>
                <PARAM NAME="logging">
                    <VALUE>true</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_Syllabizator" TYPE="Syllabizator">
                <PARAM NAME="targetType">
                    <VALUE>Syllable</VALUE>
                </PARAM>
                <PARAM NAME="inputTemplate">
                    <VALUE>{Token: kind=word,lang=cyr}</VALUE>
                </PARAM>
            </RESOURCE>

            <RESOURCE NAME="Russian_AccentGenerator" TYPE="AccentGenerator">
                <PARAM NAME="Morph_type">
                    <VALUE>Gramm</VALUE>
                </PARAM>
                <PARAM NAME="ACCPL_feature">
                    <VALUE>ACCPL</VALUE>
                </PARAM>
                <PARAM NAME="POS_feature">
                    <VALUE>POS</VALUE>
                </PARAM>
                <PARAM NAME="Klitik_feature">
                    <VALUE>Klitik</VALUE>
                </PARAM>
                <PARAM NAME="AccVariant_type">
                    <VALUE>AccVariant</VALUE>
                </PARAM>
                <PARAM NAME="MorphArr_feature">
                    <VALUE>MorphArr</VALUE>
                </PARAM>
                <PARAM NAME="Syllable_type">
                    <VALUE>Syllable</VALUE>
                </PARAM>
                <PARAM NAME="PhonWord_type">
                    <VALUE>PhonWord</VALUE>
                </PARAM>
                <!-- PARAM NAME="klitik_POSes">
                    <VALUE>PREP</VALUE>
                    <VALUE>CONJ</VALUE>
                    <VALUE>INTJ</VALUE>
                    <VALUE>PCL</VALUE>
                </PARAM -->
            </RESOURCE>

            <CHAIN NAME="MorphChain">
                <REF RESOURCE="Common_Cleanup"/>
                <REF RESOURCE="Russian_Tokeniser"/>
                <REF RESOURCE="Russian_ZalizApplier"/>
                <!--REF RESOURCE="Russian_CommaProcessor"/-->
                <REF RESOURCE="Russian_NumbersProcessor"/>
                <REF RESOURCE="Russian_MorphMinimizator"/>
                <REF RESOURCE="Russian_MorphInvarsConverter"/>
                <!--REF RESOURCE="Russian_SuperMorphInvarsConverter"/-->
                <!--REF RESOURCE="Russian_Morph_vs_SuperMorph_Minimizator"/-->
                <!--REF RESOURCE="Russian_UnknownMorphGenerator"/-->
            </CHAIN>

            <CHAIN NAME="NativeMorphChain">
                <REF RESOURCE="Common_Cleanup"/>
                <REF RESOURCE="Russian_Tokeniser"/>
                <REF RESOURCE="Russian_StarlingNativeMorphApplier"/>
                <REF RESOURCE="Russian_NumbersProcessor"/>
                <REF RESOURCE="Russian_MorphMinimizator"/>
                <REF RESOURCE="Russian_MorphInvarsConverter"/>

                <!--REF RESOURCE="Russian_UnknownMorphGenerator"/-->
                <!--REF RESOURCE="Russian_SuperMorphInvarsConverter"/-->
                <!--REF RESOURCE="Russian_Morph_vs_SuperMorph_Minimizator"/-->
            </CHAIN>

            <CHAIN NAME="MorphChainWithFreq">
                <REF RESOURCE="Common_Cleanup"/>
                <REF RESOURCE="Russian_Tokeniser"/>
                <REF RESOURCE="Russian_ZalizApplier"/>
                <!--REF RESOURCE="Russian_CommaProcessor"/-->
                <REF RESOURCE="Russian_NumbersProcessor"/>
                <REF RESOURCE="Russian_MorphMinimizator"/>
                <REF RESOURCE="Russian_MorphInvarsConverter"/>
                <REF RESOURCE="Russian_FreqDictApplier"/>
                <!--REF RESOURCE="Russian_SuperMorphInvarsConverter"/-->
                <!--REF RESOURCE="Russian_Morph_vs_SuperMorph_Minimizator"/-->
                <!--REF RESOURCE="Russian_UnknownMorphGenerator"/-->
            </CHAIN>

            <CHAIN NAME="NativeMorphChainWithFreq">
                <REF RESOURCE="Common_Cleanup"/>
                <REF RESOURCE="Russian_Tokeniser"/>
                <REF RESOURCE="Russian_StarlingNativeMorphApplier"/>
                <REF RESOURCE="Russian_NumbersProcessor"/>
                <REF RESOURCE="Russian_MorphMinimizator"/>
                <REF RESOURCE="Russian_MorphInvarsConverter"/>
                <REF RESOURCE="Russian_FreqDictApplier"/>

                <!--REF RESOURCE="Russian_UnknownMorphGenerator"/-->
                <!--REF RESOURCE="Russian_SuperMorphInvarsConverter"/-->
                <!--REF RESOURCE="Russian_Morph_vs_SuperMorph_Minimizator"/-->
            </CHAIN>

            <CHAIN NAME="MorphChainGov">
                <REF RESOURCE="Common_Cleanup"/>
                <REF RESOURCE="Russian_Tokeniser"/>
                <REF RESOURCE="Russian_ZalizApplier"/>
                <!--REF RESOURCE="Russian_CommaProcessor"/-->
                <REF RESOURCE="Russian_NumbersProcessor"/>
                <REF RESOURCE="Russian_MorphMinimizator"/>
                <REF RESOURCE="Russian_MorphInvarsConverter"/>
                <REF RESOURCE="Russian_MorphGovModelMultiplier"/>
                <!--REF RESOURCE="Russian_SuperMorphInvarsConverter"/-->
                <!--REF RESOURCE="Russian_Morph_vs_SuperMorph_Minimizator"/-->
                <!--REF RESOURCE="Russian_UnknownMorphGenerator"/-->
            </CHAIN>

            <CHAIN NAME="MorphChainUnknown">
                <REF RESOURCE="Common_Cleanup"/>
                <REF RESOURCE="Russian_Tokeniser"/>
                <REF RESOURCE="Russian_ZalizApplier"/>
                <!--REF RESOURCE="Russian_CommaProcessor"/-->
                <REF RESOURCE="Russian_NumbersProcessor"/>
                <REF RESOURCE="Russian_MorphMinimizator"/>
                <REF RESOURCE="Russian_UnknownMorphGenerator"/>
                <REF RESOURCE="Russian_UnknownMorphFsmApplier"/>
                <REF RESOURCE="Russian_MorphInvarsConverter"/>
                <!--REF RESOURCE="Russian_SuperMorphInvarsConverter"/-->
                <!--REF RESOURCE="Russian_Morph_vs_SuperMorph_Minimizator"/-->
            </CHAIN>

            <CHAIN NAME="MorphChainWithFreqUnknown">
                <REF RESOURCE="Common_Cleanup"/>
                <REF RESOURCE="Russian_Tokeniser"/>
                <REF RESOURCE="Russian_ZalizApplier"/>
                <!--REF RESOURCE="Russian_CommaProcessor"/-->
                <REF RESOURCE="Russian_NumbersProcessor"/>
                <REF RESOURCE="Russian_MorphMinimizator"/>
                <REF RESOURCE="Russian_UnknownMorphGenerator"/>
                <REF RESOURCE="Russian_UnknownMorphFsmApplier"/>
                <REF RESOURCE="Russian_MorphInvarsConverter"/>
                <REF RESOURCE="Russian_FreqDictApplier"/>
                <!--REF RESOURCE="Russian_SuperMorphInvarsConverter"/-->
                <!--REF RESOURCE="Russian_Morph_vs_SuperMorph_Minimizator"/-->
                <!--REF RESOURCE="Russian_UnknownMorphGenerator"/-->
            </CHAIN>

            <CHAIN NAME="VNPExtractorChain">
                <REF RESOURCE="Common_Cleanup"/>
                <REF RESOURCE="Russian_Tokeniser"/>
                <REF RESOURCE="Russian_ZalizApplier"/>
                <!--REF RESOURCE="Russian_CommaProcessor"/-->
                <REF RESOURCE="Russian_NumbersProcessor"/>
                <REF RESOURCE="Russian_MorphMinimizator"/>
                <REF RESOURCE="Russian_MorphInvarsConverter"/>
                <!--REF RESOURCE="Russian_SuperMorphInvarsConverter"/-->
                <!--REF RESOURCE="Russian_Morph_vs_SuperMorph_Minimizator"/-->
                <!--REF RESOURCE="Russian_UnknownMorphGenerator"/-->
                <!-- REF RESOURCE="Russian_MorphMerger"/-->
                <REF RESOURCE="Russian_VNPExtractor"/>
            </CHAIN>

            <CHAIN NAME="VNPExtractorChain2">
                <REF RESOURCE="Common_Cleanup"/>
                <REF RESOURCE="Russian_Tokeniser"/>
                <REF RESOURCE="Russian_ZalizApplier"/>
                <!--REF RESOURCE="Russian_CommaProcessor"/-->
                <REF RESOURCE="Russian_NumbersProcessor"/>
                <REF RESOURCE="Russian_MorphMinimizator"/>
                <REF RESOURCE="Russian_UnknownMorphGenerator"/>
                <REF RESOURCE="Russian_MorphInvarsConverter"/>
                <!--REF RESOURCE="Russian_SuperMorphInvarsConverter"/-->
                <!--REF RESOURCE="Russian_Morph_vs_SuperMorph_Minimizator"/-->
                <!--REF RESOURCE="Russian_UnknownMorphGenerator"/-->
                <!-- REF RESOURCE="Russian_MorphMerger"/-->
                <REF RESOURCE="Russian_VNPExtractor2"/>
            </CHAIN>

            <CHAIN NAME="MorphTrainingData">
                <REF RESOURCE="Common_Cleanup"/>
                <REF RESOURCE="Russian_Tokeniser"/>
                <REF RESOURCE="Russian_ZalizApplier"/>
                <!--REF RESOURCE="Russian_CommaProcessor"/-->
                <REF RESOURCE="Russian_NumbersProcessor"/>
                <REF RESOURCE="Russian_MorphMinimizator"/>
                <REF RESOURCE="Russian_UnknownMorphGenerator"/>
                <REF RESOURCE="Russian_MorphInvarsConverter"/>
                <!--REF RESOURCE="Russian_SuperMorphInvarsConverter"/-->
                <!--REF RESOURCE="Russian_Morph_vs_SuperMorph_Minimizator"/-->
                <!--REF RESOURCE="Russian_UnknownMorphGenerator"/-->
                <!-- REF RESOURCE="Russian_MorphMerger"/-->
                <REF RESOURCE="Russian_TrainingData"/>
            </CHAIN>

            <CHAIN NAME="PrepAttachment">
                <REF RESOURCE="Common_Cleanup"/>
                <REF RESOURCE="Russian_Tokeniser"/>
                <REF RESOURCE="Russian_ZalizApplier"/>
                <!--REF RESOURCE="Russian_CommaProcessor"/-->
                <REF RESOURCE="Russian_NumbersProcessor"/>
                <REF RESOURCE="Russian_MorphMinimizator"/>
                <REF RESOURCE="Russian_UnknownMorphGenerator"/>
                <REF RESOURCE="Russian_MorphInvarsConverter"/>
                <!--REF RESOURCE="Russian_SuperMorphInvarsConverter"/-->
                <!--REF RESOURCE="Russian_Morph_vs_SuperMorph_Minimizator"/-->
                <!--REF RESOURCE="Russian_UnknownMorphGenerator"/-->
                <!-- REF RESOURCE="Russian_MorphMerger"/-->
                <REF RESOURCE="Russian_PrepAttachment"/>
            </CHAIN>

            <DOMAIN NAME="Prosody" SHORTNAME="P" DIR="./Russian.Prosody/">
                <TYPESDCL>./types.dcl</TYPESDCL>
                <RELSXML>./relations.xml</RELSXML>

                <RESOURCE NAME="ProsodyUtil" TYPE="ScapeTransducer">
                    <PARAM NAME="rulesPath">
                        <VALUE>./resources/util/</VALUE>
                    </PARAM>
                    <PARAM NAME="mainProgram">
                        <VALUE>prosody.util.Main</VALUE>
                    </PARAM>
                </RESOURCE>

                <RESOURCE NAME="UniversalProsodyFragmentator" TYPE="ScapeTransducer">
                    <PARAM NAME="rulesPath">
                        <VALUE>./resources/fragmentator/</VALUE>
                    </PARAM>
                    <PARAM NAME="mainProgram">
                        <VALUE>prosody.Main</VALUE>
                    </PARAM>
                </RESOURCE>

                <RESOURCE NAME="OneginFragmentator" TYPE="ScapeTransducer">
                    <PARAM NAME="rulesPath">
                        <VALUE>./resources/fragmentator/</VALUE>
                    </PARAM>
                    <PARAM NAME="mainProgram">
                        <VALUE>prosody.onegin.Main</VALUE>
                    </PARAM>
                </RESOURCE>

                <RESOURCETYPE NAME="VerseProcessingResource">
                    <CLASS>treeton.res.ru.prosody.VerseProcessor</CLASS>
                </RESOURCETYPE>

                <RESOURCETYPE NAME="MeterAnalyzerResource">
                    <CLASS>treeton.res.ru.prosody.MeterAnalyzer</CLASS>
                    <PARAMDESCRIPTION NAME="benchmarkPath" TYPE="String" OPTIONAL="true"/>
                </RESOURCETYPE>

                <RESOURCETYPE NAME="MdlMeterAnalyzerResource">
                    <CLASS>treeton.res.ru.prosody.MdlMeterAnalyzer</CLASS>
                    <PARAMDESCRIPTION NAME="grammarPath" TYPE="String"/>
                    <PARAMDESCRIPTION NAME="stressRestrictionViolationWeight" TYPE="String"/>
                    <PARAMDESCRIPTION NAME="reaccentuationRestrictionViolationWeight" TYPE="String"/>
                </RESOURCETYPE>

                <RESOURCETYPE NAME="AccentDisambiguatorResource">
                    <CLASS>treeton.res.ru.prosody.AccentDisambiguator</CLASS>
                    <PARAMDESCRIPTION NAME="verseProcessingPropertiesPath" TYPE="String"/>
                </RESOURCETYPE>

                <RESOURCE NAME="VerseProcessor" TYPE="VerseProcessingResource"/>

                <RESOURCE NAME="MeterAnalyzer" TYPE="MeterAnalyzerResource">
                    <PARAM NAME="benchmarkPath">
                        <VALUE>./resources/meteranalyzer/hlebnikovMeters.txt</VALUE>
                    </PARAM>
                </RESOURCE>

                <RESOURCE NAME="MdlMeterAnalyzer" TYPE="MdlMeterAnalyzerResource">
                    <PARAM NAME="grammarPath">
                        <VALUE>./resources/meteranalyzer/first.mdl</VALUE>
                    </PARAM>
                    <PARAM NAME="stressRestrictionViolationWeight">
                        <VALUE>40</VALUE>
                    </PARAM>
                    <PARAM NAME="reaccentuationRestrictionViolationWeight">
                        <VALUE>60</VALUE>
                    </PARAM>
                </RESOURCE>

                <RESOURCE NAME="AccentDisambiguator" TYPE="AccentDisambiguatorResource">
                    <PARAM NAME="verseProcessingPropertiesPath">
                        <VALUE>./resources/meteranalyzer/verseProcessing.properties</VALUE>
                    </PARAM>
                </RESOURCE>

                <CHAIN NAME="BasicProsodyChain">
                    <REF RESOURCE="Common_Cleanup"/>
                    <REF RESOURCE="Russian_Tokeniser"/>
                    <REF RESOURCE="Russian_Syllabizator"/>
                    <REF RESOURCE="Russian_StarlingOnlyAccentMorphApplier"/>
                    <REF RESOURCE="Russian_MorphMinimizator"/>
                    <REF RESOURCE="Russian_UnknownMorphGenerator"/>
                    <REF RESOURCE="Russian_AccentGenerator"/>
                </CHAIN>

                <CHAIN NAME="OnlySyllabizatorChain">
                    <REF RESOURCE="Common_Cleanup"/>
                    <REF RESOURCE="Russian_Tokeniser"/>
                    <REF RESOURCE="Russian_Syllabizator"/>
                </CHAIN>

                <CHAIN NAME="MusimatixProsodyChain">
                    <REF RESOURCE="Common_Cleanup"/>
                    <REF RESOURCE="Russian_Tokeniser"/>
                    <REF RESOURCE="Russian_Syllabizator"/>
                    <REF RESOURCE="Russian_StarlingOnlyAccentMorphApplier"/>
                    <REF RESOURCE="Russian_MorphMinimizator"/>
                    <REF RESOURCE="Russian_UnknownMorphGenerator"/>
                    <REF RESOURCE="Russian_AccentGenerator"/>
                </CHAIN>

                <CHAIN NAME="AccentDisambiguationChain">
                    <REF RESOURCE="AccentDisambiguator"/>
                </CHAIN>

                <CHAIN NAME="OneginChain">
                    <REF RESOURCE="Common_Cleanup"/>
                    <REF RESOURCE="Russian_Tokeniser"/>
                    <REF RESOURCE="Russian_Syllabizator"/>
                    <REF RESOURCE="Russian_StarlingMorphApplier"/>
                    <!--REF RESOURCE="Russian_StarlingNativeMorphApplier"/-->
                    <REF RESOURCE="Russian_MorphMinimizator"/>
                    <REF RESOURCE="Russian_UnknownMorphGenerator"/>
                    <REF RESOURCE="OneginFragmentator"/>
                    <REF RESOURCE="Russian_AccentGenerator"/>
                    <!--REF RESOURCE="VerseProcessor"/-->
                    <REF RESOURCE="MdlMeterAnalyzer"/>
                </CHAIN>
            </DOMAIN>
        </DOMAIN>
    </DOMAIN>
</Document>


text:
/******************************************************************************
 *
 * Name: actypes.h - Common data types for the entire ACPI subsystem
 *       $Revision: 241 $
 *
 *****************************************************************************/

/******************************************************************************
 *
 * 1. Copyright Notice
 *
 * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp.
 * All rights reserved.
 *
 * 2. License
 *
 * 2.1. This is your license from Intel Corp. under its intellectual property
 * rights.  You may have additional license terms from the party that provided
 * you this software, covering your right to use that party's intellectual
 * property rights.
 *
 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
 * copy of the source code appearing in this file ("Covered Code") an
 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
 * base code distributed originally by Intel ("Original Intel Code") to copy,
 * make derivatives, distribute, use and display any portion of the Covered
 * Code in any form, with the right to sublicense such rights; and
 *
 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
 * license (with the right to sublicense), under only those claims of Intel
 * patents that are infringed by the Original Intel Code, to make, use, sell,
 * offer to sell, and import the Covered Code and derivative works thereof
 * solely to the minimum extent necessary to exercise the above copyright
 * license, and in no event shall the patent license extend to any additions
 * to or modifications of the Original Intel Code.  No other license or right
 * is granted directly or by implication, estoppel or otherwise;
 *
 * The above copyright and patent license is granted only if the following
 * conditions are met:
 *
 * 3. Conditions
 *
 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
 * Redistribution of source code of any substantial portion of the Covered
 * Code or modification with rights to further distribute source must include
 * the above Copyright Notice, the above License, this list of Conditions,
 * and the following Disclaimer and Export Compliance provision.  In addition,
 * Licensee must cause all Covered Code to which Licensee contributes to
 * contain a file documenting the changes Licensee made to create that Covered
 * Code and the date of any change.  Licensee must include in that file the
 * documentation of any changes made by any predecessor Licensee.  Licensee
 * must include a prominent statement that the modification is derived,
 * directly or indirectly, from Original Intel Code.
 *
 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
 * Redistribution of source code of any substantial portion of the Covered
 * Code or modification without rights to further distribute source must
 * include the following Disclaimer and Export Compliance provision in the
 * documentation and/or other materials provided with distribution.  In
 * addition, Licensee may not authorize further sublicense of source of any
 * portion of the Covered Code, and must include terms to the effect that the
 * license from Licensee to its licensee is limited to the intellectual
 * property embodied in the software Licensee provides to its licensee, and
 * not to intellectual property embodied in modifications its licensee may
 * make.
 *
 * 3.3. Redistribution of Executable. Redistribution in executable form of any
 * substantial portion of the Covered Code or modification must reproduce the
 * above Copyright Notice, and the following Disclaimer and Export Compliance
 * provision in the documentation and/or other materials provided with the
 * distribution.
 *
 * 3.4. Intel retains all right, title, and interest in and to the Original
 * Intel Code.
 *
 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
 * Intel shall be used in advertising or otherwise to promote the sale, use or
 * other dealings in products derived from or relating to the Covered Code
 * without prior written authorization from Intel.
 *
 * 4. Disclaimer and Export Compliance
 *
 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
 * PARTICULAR PURPOSE.
 *
 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
 * LIMITED REMEDY.
 *
 * 4.3. Licensee shall not export, either directly or indirectly, any of this
 * software or system incorporating such software without first obtaining any
 * required license or other approval from the U. S. Department of Commerce or
 * any other agency or department of the United States Government.  In the
 * event Licensee exports any such software from the United States or
 * re-exports any such software from a foreign destination, Licensee shall
 * ensure that the distribution and export/re-export of the software is in
 * compliance with all laws, regulations, orders, or other restrictions of the
 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 * any of its subsidiaries will export/re-export any technical data, process,
 * software, or service, directly or indirectly, to any country for which the
 * United States government or any agency thereof requires an export license,
 * other governmental approval, or letter of assurance, without first obtaining
 * such license, approval or letter.
 *
 *****************************************************************************/

#ifndef __ACTYPES_H__
#define __ACTYPES_H__

/*! [Begin] no source code translation (keep the typedefs) */

/*
 * Data type ranges
 */
#define ACPI_UINT8_MAX                  (UINT8)  0xFF
#define ACPI_UINT16_MAX                 (UINT16) 0xFFFF
#define ACPI_UINT32_MAX                 (UINT32) 0xFFFFFFFF
#define ACPI_UINT64_MAX                 (UINT64) 0xFFFFFFFFFFFFFFFF
#define ACPI_ASCII_MAX                  0x7F

/*
 * Data types - Fixed across all compilation models (16/32/64)
 *
 * BOOLEAN      Logical Boolean.
 * INT8         8-bit  (1 byte) signed value
 * UINT8        8-bit  (1 byte) unsigned value
 * INT16        16-bit (2 byte) signed value
 * UINT16       16-bit (2 byte) unsigned value
 * INT32        32-bit (4 byte) signed value
 * UINT32       32-bit (4 byte) unsigned value
 * INT64        64-bit (8 byte) signed value
 * UINT64       64-bit (8 byte) unsigned value
 * NATIVE_INT   32-bit on IA-32, 64-bit on IA-64 signed value
 * NATIVE_UINT  32-bit on IA-32, 64-bit on IA-64 unsigned value
 */

#ifndef ACPI_MACHINE_WIDTH
#error ACPI_MACHINE_WIDTH not defined
#endif

#if ACPI_MACHINE_WIDTH == 64
/*
 * 64-bit type definitions
 */
typedef unsigned char                   UINT8;
typedef unsigned char                   BOOLEAN;
typedef unsigned short                  UINT16;
typedef int                             INT32;
typedef unsigned int                    UINT32;
typedef COMPILER_DEPENDENT_INT64        INT64;
typedef COMPILER_DEPENDENT_UINT64       UINT64;

typedef INT64                           NATIVE_INT;
typedef UINT64                          NATIVE_UINT;

typedef UINT32                          NATIVE_UINT_MAX32;
typedef UINT64                          NATIVE_UINT_MIN32;

typedef UINT64                          ACPI_TBLPTR;
typedef UINT64                          ACPI_IO_ADDRESS;
typedef UINT64                          ACPI_PHYSICAL_ADDRESS;
typedef UINT64                          ACPI_SIZE;

#define ALIGNED_ADDRESS_BOUNDARY        0x00000008      /* No hardware alignment support in IA64 */
#define ACPI_USE_NATIVE_DIVIDE                          /* Native 64-bit integer support */
#define ACPI_MAX_PTR                    ACPI_UINT64_MAX
#define ACPI_SIZE_MAX                   ACPI_UINT64_MAX

#elif ACPI_MACHINE_WIDTH == 16

/*
 * 16-bit type definitions
 */
typedef unsigned char                   UINT8;
typedef unsigned char                   BOOLEAN;
typedef unsigned int                    UINT16;
typedef long                            INT32;
typedef int                             INT16;
typedef unsigned long                   UINT32;

typedef struct
{
    UINT32                                  Lo;
    UINT32                                  Hi;

} UINT64;

typedef UINT16                          NATIVE_UINT;
typedef INT16                           NATIVE_INT;

typedef UINT16                          NATIVE_UINT_MAX32;
typedef UINT32                          NATIVE_UINT_MIN32;

typedef UINT32                          ACPI_TBLPTR;
typedef UINT32                          ACPI_IO_ADDRESS;
typedef char                            *ACPI_PHYSICAL_ADDRESS;
typedef UINT16                          ACPI_SIZE;

#define ALIGNED_ADDRESS_BOUNDARY        0x00000002
#define _HW_ALIGNMENT_SUPPORT
#define ACPI_USE_NATIVE_DIVIDE                          /* No 64-bit integers, ok to use native divide */
#define ACPI_MAX_PTR                    ACPI_UINT16_MAX
#define ACPI_SIZE_MAX                   ACPI_UINT16_MAX

/*
 * (16-bit only) internal integers must be 32-bits, so
 * 64-bit integers cannot be supported
 */
#define ACPI_NO_INTEGER64_SUPPORT

#elif ACPI_MACHINE_WIDTH == 32

/*
 * 32-bit type definitions (default)
 */
typedef unsigned char                   UINT8;
typedef unsigned char                   BOOLEAN;
typedef unsigned short                  UINT16;
typedef int                             INT32;
typedef unsigned int                    UINT32;
typedef COMPILER_DEPENDENT_INT64        INT64;
typedef COMPILER_DEPENDENT_UINT64       UINT64;

typedef INT32                           NATIVE_INT;
typedef UINT32                          NATIVE_UINT;

typedef UINT32                          NATIVE_UINT_MAX32;
typedef UINT32                          NATIVE_UINT_MIN32;

typedef UINT64                          ACPI_TBLPTR;
typedef UINT32                          ACPI_IO_ADDRESS;
typedef UINT64                          ACPI_PHYSICAL_ADDRESS;
typedef UINT32                          ACPI_SIZE;

#define ALIGNED_ADDRESS_BOUNDARY        0x00000004
#define _HW_ALIGNMENT_SUPPORT
#define ACPI_MAX_PTR                    ACPI_UINT32_MAX
#define ACPI_SIZE_MAX                   ACPI_UINT32_MAX

#else
#error unknown ACPI_MACHINE_WIDTH
#endif

/*
 * Miscellaneous common types
 */
typedef UINT32                          UINT32_BIT;
typedef NATIVE_UINT                     ACPI_PTRDIFF;
typedef char                            NATIVE_CHAR;

#ifdef DEFINE_ALTERNATE_TYPES
/*
 * Types used only in translated source, defined here to enable
 * cross-platform compilation only.
 */
typedef INT32                           s32;
typedef UINT8                           u8;
typedef UINT16                          u16;
typedef UINT32                          u32;
typedef UINT64                          u64;
#endif
/*! [End] no source code translation !*/

/*
 * Pointer overlays to avoid lots of typecasting for
 * code that accepts both physical and logical pointers.
 */
typedef union acpi_ptrs
{
    ACPI_PHYSICAL_ADDRESS       Physical;
    void                        *Logical;
    ACPI_TBLPTR                 Value;

} ACPI_POINTERS;

typedef struct AcpiPointer
{
    UINT32                      PointerType;
    union acpi_ptrs             Pointer;

} ACPI_POINTER;

/* PointerTypes for above */

#define ACPI_PHYSICAL_POINTER           0x01
#define ACPI_LOGICAL_POINTER            0x02

/* Processor mode */

#define ACPI_PHYSICAL_ADDRESSING        0x04
#define ACPI_LOGICAL_ADDRESSING         0x08
#define ACPI_MEMORY_MODE                0x0C

#define ACPI_PHYSMODE_PHYSPTR           ACPI_PHYSICAL_ADDRESSING | ACPI_PHYSICAL_POINTER
#define ACPI_LOGMODE_PHYSPTR            ACPI_LOGICAL_ADDRESSING  | ACPI_PHYSICAL_POINTER
#define ACPI_LOGMODE_LOGPTR             ACPI_LOGICAL_ADDRESSING  | ACPI_LOGICAL_POINTER

/*
 * Useful defines
 */
#ifdef FALSE
#undef FALSE
#endif
#define FALSE                           (1 == 0)

#ifdef TRUE
#undef TRUE
#endif
#define TRUE                            (1 == 1)

#ifndef NULL
#define NULL                            (void *) 0
#endif

/*
 * Local datatypes
 */
typedef UINT32                          ACPI_STATUS;    /* All ACPI Exceptions */
typedef UINT32                          ACPI_NAME;      /* 4-byte ACPI name */
typedef char*                           ACPI_STRING;    /* Null terminated ASCII string */
typedef void*                           ACPI_HANDLE;    /* Actually a ptr to an Node */

typedef struct
{
    UINT32                      Lo;
    UINT32                      Hi;

} UINT64_STRUCT;

typedef union
{
    UINT64                      Full;
    UINT64_STRUCT               Part;

} UINT64_OVERLAY;

typedef struct
{
    UINT32                      Lo;
    UINT32                      Hi;

} UINT32_STRUCT;

/*
 * Acpi integer width. In ACPI version 1, integers are
 * 32 bits.  In ACPI version 2, integers are 64 bits.
 * Note that this pertains to the ACPI integer type only, not
 * other integers used in the implementation of the ACPI CA
 * subsystem.
 */
#ifdef ACPI_NO_INTEGER64_SUPPORT

/* 32-bit integers only, no 64-bit support */

typedef UINT32                          ACPI_INTEGER;
#define ACPI_INTEGER_MAX                ACPI_UINT32_MAX
#define ACPI_INTEGER_BIT_SIZE           32
#define ACPI_MAX_BCD_VALUE              99999999
#define ACPI_MAX_BCD_DIGITS             8
#define ACPI_MAX_DECIMAL_DIGITS         10

#define ACPI_USE_NATIVE_DIVIDE          /* Use compiler native 32-bit divide */

#else

/* 64-bit integers */

typedef UINT64                          ACPI_INTEGER;
#define ACPI_INTEGER_MAX                ACPI_UINT64_MAX
#define ACPI_INTEGER_BIT_SIZE           64
#define ACPI_MAX_BCD_VALUE              9999999999999999
#define ACPI_MAX_BCD_DIGITS             16
#define ACPI_MAX_DECIMAL_DIGITS         19

#if ACPI_MACHINE_WIDTH == 64
#define ACPI_USE_NATIVE_DIVIDE          /* Use compiler native 64-bit divide */
#endif
#endif

/*
 * Constants with special meanings
 */
#define ACPI_ROOT_OBJECT                (ACPI_HANDLE) ACPI_PTR_ADD (char, NULL, ACPI_MAX_PTR)

/*
 * Initialization sequence
 */
#define ACPI_FULL_INITIALIZATION        0x00
#define ACPI_NO_ADDRESS_SPACE_INIT      0x01
#define ACPI_NO_HARDWARE_INIT           0x02
#define ACPI_NO_EVENT_INIT              0x04
#define ACPI_NO_HANDLER_INIT            0x08
#define ACPI_NO_ACPI_ENABLE             0x10
#define ACPI_NO_DEVICE_INIT             0x20
#define ACPI_NO_OBJECT_INIT             0x40

/*
 * Initialization state
 */
#define ACPI_INITIALIZED_OK             0x01

/*
 * Power state values
 */

#define ACPI_STATE_UNKNOWN              (UINT8) 0xFF

#define ACPI_STATE_S0                   (UINT8) 0
#define ACPI_STATE_S1                   (UINT8) 1
#define ACPI_STATE_S2                   (UINT8) 2
#define ACPI_STATE_S3                   (UINT8) 3
#define ACPI_STATE_S4                   (UINT8) 4
#define ACPI_STATE_S5                   (UINT8) 5
#define ACPI_S_STATES_MAX               ACPI_STATE_S5
#define ACPI_S_STATE_COUNT              6

#define ACPI_STATE_D0                   (UINT8) 0
#define ACPI_STATE_D1                   (UINT8) 1
#define ACPI_STATE_D2                   (UINT8) 2
#define ACPI_STATE_D3                   (UINT8) 3
#define ACPI_D_STATES_MAX               ACPI_STATE_D3
#define ACPI_D_STATE_COUNT              4

#define ACPI_STATE_C0                   (UINT8) 0
#define ACPI_STATE_C1                   (UINT8) 1
#define ACPI_STATE_C2                   (UINT8) 2
#define ACPI_STATE_C3                   (UINT8) 3
#define ACPI_C_STATES_MAX               ACPI_STATE_C3
#define ACPI_C_STATE_COUNT              4

/*
 * Sleep type invalid value
 */
#define ACPI_SLEEP_TYPE_MAX             0x7
#define ACPI_SLEEP_TYPE_INVALID         0xFF

/*
 * Standard notify values
 */
#define ACPI_NOTIFY_BUS_CHECK           (UINT8) 0
#define ACPI_NOTIFY_DEVICE_CHECK        (UINT8) 1
#define ACPI_NOTIFY_DEVICE_WAKE         (UINT8) 2
#define ACPI_NOTIFY_EJECT_REQUEST       (UINT8) 3
#define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (UINT8) 4
#define ACPI_NOTIFY_FREQUENCY_MISMATCH  (UINT8) 5
#define ACPI_NOTIFY_BUS_MODE_MISMATCH   (UINT8) 6
#define ACPI_NOTIFY_POWER_FAULT         (UINT8) 7

/*
 *  Table types.  These values are passed to the table related APIs
 */
typedef UINT32                          ACPI_TABLE_TYPE;

#define ACPI_TABLE_RSDP                 (ACPI_TABLE_TYPE) 0
#define ACPI_TABLE_DSDT                 (ACPI_TABLE_TYPE) 1
#define ACPI_TABLE_FADT                 (ACPI_TABLE_TYPE) 2
#define ACPI_TABLE_FACS                 (ACPI_TABLE_TYPE) 3
#define ACPI_TABLE_PSDT                 (ACPI_TABLE_TYPE) 4
#define ACPI_TABLE_SSDT                 (ACPI_TABLE_TYPE) 5
#define ACPI_TABLE_XSDT                 (ACPI_TABLE_TYPE) 6
#define ACPI_TABLE_MAX                  6
#define NUM_ACPI_TABLES                 (ACPI_TABLE_MAX+1)

/*
 * Types associated with ACPI names and objects.  The first group of
 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
 * of the ACPI ObjectType() operator (See the ACPI Spec).  Therefore,
 * only add to the first group if the spec changes.
 *
 * Types must be kept in sync with the global AcpiNsProperties
 * and AcpiNsTypeNames arrays.
 */
typedef UINT32                          ACPI_OBJECT_TYPE;

#define ACPI_TYPE_ANY                   0x00
#define ACPI_TYPE_INTEGER               0x01  /* Byte/Word/Dword/Zero/One/Ones */
#define ACPI_TYPE_STRING                0x02
#define ACPI_TYPE_BUFFER                0x03
#define ACPI_TYPE_PACKAGE               0x04  /* ByteConst, multiple DataTerm/Constant/SuperName */
#define ACPI_TYPE_FIELD_UNIT            0x05
#define ACPI_TYPE_DEVICE                0x06  /* Name, multiple Node */
#define ACPI_TYPE_EVENT                 0x07
#define ACPI_TYPE_METHOD                0x08  /* Name, ByteConst, multiple Code */
#define ACPI_TYPE_MUTEX                 0x09
#define ACPI_TYPE_REGION                0x0A
#define ACPI_TYPE_POWER                 0x0B  /* Name,ByteConst,WordConst,multi Node */
#define ACPI_TYPE_PROCESSOR             0x0C  /* Name,ByteConst,DWordConst,ByteConst,multi NmO */
#define ACPI_TYPE_THERMAL               0x0D  /* Name, multiple Node */
#define ACPI_TYPE_BUFFER_FIELD          0x0E
#define ACPI_TYPE_DDB_HANDLE            0x0F
#define ACPI_TYPE_DEBUG_OBJECT          0x10

#define ACPI_TYPE_EXTERNAL_MAX          0x10

/*
 * These are object types that do not map directly to the ACPI
 * ObjectType() operator. They are used for various internal purposes only.
 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
 * internal types must move upwards. (There is code that depends on these
 * values being contiguous with the external types above.)
 */
#define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
#define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
#define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
#define ACPI_TYPE_LOCAL_REFERENCE       0x14  /* Arg#, Local#, Name, Debug, RefOf, Index */
#define ACPI_TYPE_LOCAL_ALIAS           0x15
#define ACPI_TYPE_LOCAL_NOTIFY          0x16
#define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x17
#define ACPI_TYPE_LOCAL_RESOURCE        0x18
#define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x19
#define ACPI_TYPE_LOCAL_SCOPE           0x1A  /* 1 Name, multiple ObjectList Nodes */

#define ACPI_TYPE_NS_NODE_MAX           0x1A  /* Last typecode used within a NS Node */

/*
 * These are special object types that never appear in
 * a Namespace node, only in an ACPI_OPERAND_OBJECT
 */
#define ACPI_TYPE_LOCAL_EXTRA           0x1B
#define ACPI_TYPE_LOCAL_DATA            0x1C

#define ACPI_TYPE_LOCAL_MAX             0x1C

/* All types above here are invalid */

#define ACPI_TYPE_INVALID               0x1D
#define ACPI_TYPE_NOT_FOUND             0xFF

/*
 * Bitmapped ACPI types.  Used internally only
 */
#define ACPI_BTYPE_ANY                  0x00000000
#define ACPI_BTYPE_INTEGER              0x00000001
#define ACPI_BTYPE_STRING               0x00000002
#define ACPI_BTYPE_BUFFER               0x00000004
#define ACPI_BTYPE_PACKAGE              0x00000008
#define ACPI_BTYPE_FIELD_UNIT           0x00000010
#define ACPI_BTYPE_DEVICE               0x00000020
#define ACPI_BTYPE_EVENT                0x00000040
#define ACPI_BTYPE_METHOD               0x00000080
#define ACPI_BTYPE_MUTEX                0x00000100
#define ACPI_BTYPE_REGION               0x00000200
#define ACPI_BTYPE_POWER                0x00000400
#define ACPI_BTYPE_PROCESSOR            0x00000800
#define ACPI_BTYPE_THERMAL              0x00001000
#define ACPI_BTYPE_BUFFER_FIELD         0x00002000
#define ACPI_BTYPE_DDB_HANDLE           0x00004000
#define ACPI_BTYPE_DEBUG_OBJECT         0x00008000
#define ACPI_BTYPE_REFERENCE            0x00010000
#define ACPI_BTYPE_RESOURCE             0x00020000

#define ACPI_BTYPE_COMPUTE_DATA         (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)

#define ACPI_BTYPE_DATA                 (ACPI_BTYPE_COMPUTE_DATA  | ACPI_BTYPE_PACKAGE)
#define ACPI_BTYPE_DATA_REFERENCE       (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
#define ACPI_BTYPE_DEVICE_OBJECTS       (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
#define ACPI_BTYPE_OBJECTS_AND_REFS     0x0001FFFF  /* ARG or LOCAL */
#define ACPI_BTYPE_ALL_OBJECTS          0x0000FFFF

/*
 * All I/O
 */
#define ACPI_READ                       0
#define ACPI_WRITE                      1
#define ACPI_IO_MASK                    1

/*
 * AcpiEvent Types: Fixed & General Purpose
 */
typedef UINT32                          ACPI_EVENT_TYPE;

#define ACPI_EVENT_FIXED                0
#define ACPI_EVENT_GPE                  1

/*
 * Fixed events
 */
#define ACPI_EVENT_PMTIMER              0
#define ACPI_EVENT_GLOBAL               1
#define ACPI_EVENT_POWER_BUTTON         2
#define ACPI_EVENT_SLEEP_BUTTON         3
#define ACPI_EVENT_RTC                  4
#define ACPI_EVENT_MAX                  4
#define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1

#define ACPI_GPE_INVALID                0xFF
#define ACPI_GPE_MAX                    0xFF
#define ACPI_NUM_GPE                    256

#define ACPI_EVENT_LEVEL_TRIGGERED      1
#define ACPI_EVENT_EDGE_TRIGGERED       2

/*
 * GPEs
 */
#define ACPI_EVENT_WAKE_ENABLE          0x1
#define ACPI_EVENT_WAKE_DISABLE         0x1

/*
 * AcpiEvent Status:
 * -------------
 * The encoding of ACPI_EVENT_STATUS is illustrated below.
 * Note that a set bit (1) indicates the property is TRUE
 * (e.g. if bit 0 is set then the event is enabled).
 * +-------------+-+-+-+
 * |   Bits 31:3 |2|1|0|
 * +-------------+-+-+-+
 *          |     | | |
 *          |     | | +- Enabled?
 *          |     | +--- Enabled for wake?
 *          |     +----- Set?
 *          +----------- <Reserved>
 */
typedef UINT32                          ACPI_EVENT_STATUS;

#define ACPI_EVENT_FLAG_DISABLED        (ACPI_EVENT_STATUS) 0x00
#define ACPI_EVENT_FLAG_ENABLED         (ACPI_EVENT_STATUS) 0x01
#define ACPI_EVENT_FLAG_WAKE_ENABLED    (ACPI_EVENT_STATUS) 0x02
#define ACPI_EVENT_FLAG_SET             (ACPI_EVENT_STATUS) 0x04

/* Notify types */

#define ACPI_SYSTEM_NOTIFY              0
#define ACPI_DEVICE_NOTIFY              1
#define ACPI_MAX_NOTIFY_HANDLER_TYPE    1

#define ACPI_MAX_SYS_NOTIFY             0x7f

/* Address Space (Operation Region) Types */

typedef UINT8                           ACPI_ADR_SPACE_TYPE;

#define ACPI_ADR_SPACE_SYSTEM_MEMORY    (ACPI_ADR_SPACE_TYPE) 0
#define ACPI_ADR_SPACE_SYSTEM_IO        (ACPI_ADR_SPACE_TYPE) 1
#define ACPI_ADR_SPACE_PCI_CONFIG       (ACPI_ADR_SPACE_TYPE) 2
#define ACPI_ADR_SPACE_EC               (ACPI_ADR_SPACE_TYPE) 3
#define ACPI_ADR_SPACE_SMBUS            (ACPI_ADR_SPACE_TYPE) 4
#define ACPI_ADR_SPACE_CMOS             (ACPI_ADR_SPACE_TYPE) 5
#define ACPI_ADR_SPACE_PCI_BAR_TARGET   (ACPI_ADR_SPACE_TYPE) 6
#define ACPI_ADR_SPACE_DATA_TABLE       (ACPI_ADR_SPACE_TYPE) 7

/*
 * BitRegister IDs
 * These are bitfields defined within the full ACPI registers
 */
#define ACPI_BITREG_TIMER_STATUS                0x00
#define ACPI_BITREG_BUS_MASTER_STATUS           0x01
#define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
#define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
#define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
#define ACPI_BITREG_RT_CLOCK_STATUS             0x05
#define ACPI_BITREG_WAKE_STATUS                 0x06

#define ACPI_BITREG_TIMER_ENABLE                0x07
#define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x08
#define ACPI_BITREG_POWER_BUTTON_ENABLE         0x09
#define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0A
#define ACPI_BITREG_RT_CLOCK_ENABLE             0x0B
#define ACPI_BITREG_WAKE_ENABLE                 0x0C

#define ACPI_BITREG_SCI_ENABLE                  0x0D
#define ACPI_BITREG_BUS_MASTER_RLD              0x0E
#define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x0F
#define ACPI_BITREG_SLEEP_TYPE_A                0x10
#define ACPI_BITREG_SLEEP_TYPE_B                0x11
#define ACPI_BITREG_SLEEP_ENABLE                0x12

#define ACPI_BITREG_ARB_DISABLE                 0x13

#define ACPI_BITREG_MAX                         0x13
#define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1

/*
 * External ACPI object definition
 */
typedef union AcpiObj
{
    ACPI_OBJECT_TYPE            Type;   /* See definition of AcpiNsType for values */
    struct
    {
        ACPI_OBJECT_TYPE            Type;
        ACPI_INTEGER                Value;      /* The actual number */
    } Integer;

    struct
    {
        ACPI_OBJECT_TYPE            Type;
        UINT32                      Length;     /* # of bytes in string, excluding trailing null */
        NATIVE_CHAR                 *Pointer;   /* points to the string value */
    } String;

    struct
    {
        ACPI_OBJECT_TYPE            Type;
        UINT32                      Length;     /* # of bytes in buffer */
        UINT8                       *Pointer;   /* points to the buffer */
    } Buffer;

    struct
    {
        ACPI_OBJECT_TYPE            Type;
        UINT32                      Fill1;
        ACPI_HANDLE                 Handle;     /* object reference */
    } Reference;

    struct
    {
        ACPI_OBJECT_TYPE            Type;
        UINT32                      Count;      /* # of elements in package */
        union AcpiObj               *Elements;  /* Pointer to an array of ACPI_OBJECTs */
    } Package;

    struct
    {
        ACPI_OBJECT_TYPE            Type;
        UINT32                      ProcId;
        ACPI_IO_ADDRESS             PblkAddress;
        UINT32                      PblkLength;
    } Processor;

    struct
    {
        ACPI_OBJECT_TYPE            Type;
        UINT32                      SystemLevel;
        UINT32                      ResourceOrder;
    } PowerResource;

} ACPI_OBJECT;

/*
 * List of objects, used as a parameter list for control method evaluation
 */
typedef struct AcpiObjList
{
    UINT32                      Count;
    ACPI_OBJECT                 *Pointer;

} ACPI_OBJECT_LIST;

/*
 * Miscellaneous common Data Structures used by the interfaces
 */
#define ACPI_NO_BUFFER              0
#define ACPI_ALLOCATE_BUFFER        (ACPI_SIZE) (-1)
#define ACPI_ALLOCATE_LOCAL_BUFFER  (ACPI_SIZE) (-2)

typedef struct
{
    ACPI_SIZE                   Length;         /* Length in bytes of the buffer */
    void                        *Pointer;       /* pointer to buffer */

} ACPI_BUFFER;

/*
 * NameType for AcpiGetName
 */
#define ACPI_FULL_PATHNAME              0
#define ACPI_SINGLE_NAME                1
#define ACPI_NAME_TYPE_MAX              1

/*
 * Structure and flags for AcpiGetSystemInfo
 */
#define ACPI_SYS_MODE_UNKNOWN           0x0000
#define ACPI_SYS_MODE_ACPI              0x0001
#define ACPI_SYS_MODE_LEGACY            0x0002
#define ACPI_SYS_MODES_MASK             0x0003

/*
 * ACPI Table Info.  One per ACPI table _type_
 */
typedef struct AcpiTableInfo
{
    UINT32                      Count;

} ACPI_TABLE_INFO;

/*
 * System info returned by AcpiGetSystemInfo()
 */
typedef struct _AcpiSysInfo
{
    UINT32                      AcpiCaVersion;
    UINT32                      Flags;
    UINT32                      TimerResolution;
    UINT32                      Reserved1;
    UINT32                      Reserved2;
    UINT32                      DebugLevel;
    UINT32                      DebugLayer;
    UINT32                      NumTableTypes;
    ACPI_TABLE_INFO             TableInfo [NUM_ACPI_TABLES];

} ACPI_SYSTEM_INFO;

/*
 * Various handlers and callback procedures
 */
typedef
UINT32 (*ACPI_EVENT_HANDLER) (
    void                        *Context);

typedef
void (*ACPI_GPE_HANDLER) (
    void                        *Context);

typedef
void (*ACPI_NOTIFY_HANDLER) (
    ACPI_HANDLE                 Device,
    UINT32                      Value,
    void                        *Context);

typedef
void (*ACPI_OBJECT_HANDLER) (
    ACPI_HANDLE                 Object,
    UINT32                      Function,
    void                        *Data);

typedef
ACPI_STATUS (*ACPI_INIT_HANDLER) (
    ACPI_HANDLE                 Object,
    UINT32                      Function);

#define ACPI_INIT_DEVICE_INI        1

/* Address Spaces (Operation Regions */

typedef
ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER) (
    UINT32                      Function,
    ACPI_PHYSICAL_ADDRESS       Address,
    UINT32                      BitWidth,
    ACPI_INTEGER                *Value,
    void                        *HandlerContext,
    void                        *RegionContext);

#define ACPI_DEFAULT_HANDLER        NULL

typedef
ACPI_STATUS (*ACPI_ADR_SPACE_SETUP) (
    ACPI_HANDLE                 RegionHandle,
    UINT32                      Function,
    void                        *HandlerContext,
    void                        **RegionContext);

#define ACPI_REGION_ACTIVATE    0
#define ACPI_REGION_DEACTIVATE  1

typedef
ACPI_STATUS (*ACPI_WALK_CALLBACK) (
    ACPI_HANDLE                 ObjHandle,
    UINT32                      NestingLevel,
    void                        *Context,
    void                        **ReturnValue);

/* Interrupt handler return values */

#define ACPI_INTERRUPT_NOT_HANDLED      0x00
#define ACPI_INTERRUPT_HANDLED          0x01

/* Structure and flags for AcpiGetDeviceInfo */

#define ACPI_VALID_HID                  0x1
#define ACPI_VALID_UID                  0x2
#define ACPI_VALID_ADR                  0x4
#define ACPI_VALID_STA                  0x8

#define ACPI_COMMON_OBJ_INFO \
    ACPI_OBJECT_TYPE            Type;           /* ACPI object type */ \
    ACPI_NAME                   Name            /* ACPI object Name */

typedef struct
{
    ACPI_COMMON_OBJ_INFO;
} ACPI_OBJ_INFO_HEADER;

typedef struct
{
    ACPI_COMMON_OBJ_INFO;

    UINT32                      Valid;              /*  Are the next bits legit? */
    NATIVE_CHAR                 HardwareId[9];      /*  _HID value if any */
    NATIVE_CHAR                 UniqueId[9];        /*  _UID value if any */
    ACPI_INTEGER                Address;            /*  _ADR value if any */
    UINT32                      CurrentStatus;      /*  _STA value */
} ACPI_DEVICE_INFO;

/* Context structs for address space handlers */

typedef struct
{
    UINT16                      Segment;
    UINT16                      Bus;
    UINT16                      Device;
    UINT16                      Function;
} ACPI_PCI_ID;

typedef struct
{
    UINT32                      Length;
    ACPI_PHYSICAL_ADDRESS       Address;
    ACPI_PHYSICAL_ADDRESS       MappedPhysicalAddress;
    UINT8                       *MappedLogicalAddress;
    ACPI_SIZE                   MappedLength;
} ACPI_MEM_SPACE_CONTEXT;

/* Sleep states */

#define ACPI_NUM_SLEEP_STATES           7

/*
 * Definitions for Resource Attributes
 */

/*
 *  Memory Attributes
 */
#define ACPI_READ_ONLY_MEMORY           (UINT8) 0x00
#define ACPI_READ_WRITE_MEMORY          (UINT8) 0x01

#define ACPI_NON_CACHEABLE_MEMORY       (UINT8) 0x00
#define ACPI_CACHABLE_MEMORY            (UINT8) 0x01
#define ACPI_WRITE_COMBINING_MEMORY     (UINT8) 0x02
#define ACPI_PREFETCHABLE_MEMORY        (UINT8) 0x03

/*
 *  IO Attributes
 *  The ISA IO ranges are:     n000-n0FFh,  n400-n4FFh, n800-n8FFh, nC00-nCFFh.
 *  The non-ISA IO ranges are: n100-n3FFh,  n500-n7FFh, n900-nBFFh, nCD0-nFFFh.
 */
#define ACPI_NON_ISA_ONLY_RANGES        (UINT8) 0x01
#define ACPI_ISA_ONLY_RANGES            (UINT8) 0x02
#define ACPI_ENTIRE_RANGE               (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)

/*
 *  IO Port Descriptor Decode
 */
#define ACPI_DECODE_10                  (UINT8) 0x00    /* 10-bit IO address decode */
#define ACPI_DECODE_16                  (UINT8) 0x01    /* 16-bit IO address decode */

/*
 *  IRQ Attributes
 */
#define ACPI_EDGE_SENSITIVE             (UINT8) 0x00
#define ACPI_LEVEL_SENSITIVE            (UINT8) 0x01

#define ACPI_ACTIVE_HIGH                (UINT8) 0x00
#define ACPI_ACTIVE_LOW                 (UINT8) 0x01

#define ACPI_EXCLUSIVE                  (UINT8) 0x00
#define ACPI_SHARED                     (UINT8) 0x01

/*
 *  DMA Attributes
 */
#define ACPI_COMPATIBILITY              (UINT8) 0x00
#define ACPI_TYPE_A                     (UINT8) 0x01
#define ACPI_TYPE_B                     (UINT8) 0x02
#define ACPI_TYPE_F                     (UINT8) 0x03

#define ACPI_NOT_BUS_MASTER             (UINT8) 0x00
#define ACPI_BUS_MASTER                 (UINT8) 0x01

#define ACPI_TRANSFER_8                 (UINT8) 0x00
#define ACPI_TRANSFER_8_16              (UINT8) 0x01
#define ACPI_TRANSFER_16                (UINT8) 0x02

/*
 * Start Dependent Functions Priority definitions
 */
#define ACPI_GOOD_CONFIGURATION         (UINT8) 0x00
#define ACPI_ACCEPTABLE_CONFIGURATION   (UINT8) 0x01
#define ACPI_SUB_OPTIMAL_CONFIGURATION  (UINT8) 0x02

/*
 *  16, 32 and 64-bit Address Descriptor resource types
 */
#define ACPI_MEMORY_RANGE               (UINT8) 0x00
#define ACPI_IO_RANGE                   (UINT8) 0x01
#define ACPI_BUS_NUMBER_RANGE           (UINT8) 0x02

#define ACPI_ADDRESS_NOT_FIXED          (UINT8) 0x00
#define ACPI_ADDRESS_FIXED              (UINT8) 0x01

#define ACPI_POS_DECODE                 (UINT8) 0x00
#define ACPI_SUB_DECODE                 (UINT8) 0x01

#define ACPI_PRODUCER                   (UINT8) 0x00
#define ACPI_CONSUMER                   (UINT8) 0x01

/*
 *  Structures used to describe device resources
 */
typedef struct
{
    UINT32                      EdgeLevel;
    UINT32                      ActiveHighLow;
    UINT32                      SharedExclusive;
    UINT32                      NumberOfInterrupts;
    UINT32                      Interrupts[1];

} ACPI_RESOURCE_IRQ;

typedef struct
{
    UINT32                      Type;
    UINT32                      BusMaster;
    UINT32                      Transfer;
    UINT32                      NumberOfChannels;
    UINT32                      Channels[1];

} ACPI_RESOURCE_DMA;

typedef struct
{
    UINT32                      CompatibilityPriority;
    UINT32                      PerformanceRobustness;

} ACPI_RESOURCE_START_DPF;

/*
 * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
 * needed because it has no fields
 */

typedef struct
{
    UINT32                      IoDecode;
    UINT32                      MinBaseAddress;
    UINT32                      MaxBaseAddress;
    UINT32                      Alignment;
    UINT32                      RangeLength;

} ACPI_RESOURCE_IO;

typedef struct
{
    UINT32                      BaseAddress;
    UINT32                      RangeLength;

} ACPI_RESOURCE_FIXED_IO;

typedef struct
{
    UINT32                      Length;
    UINT8                       Reserved[1];

} ACPI_RESOURCE_VENDOR;

typedef struct
{
    UINT8                       Checksum;

} ACPI_RESOURCE_END_TAG;

typedef struct
{
    UINT32                      ReadWriteAttribute;
    UINT32                      MinBaseAddress;
    UINT32                      MaxBaseAddress;
    UINT32                      Alignment;
    UINT32                      RangeLength;

} ACPI_RESOURCE_MEM24;

typedef struct
{
    UINT32                      ReadWriteAttribute;
    UINT32                      MinBaseAddress;
    UINT32                      MaxBaseAddress;
    UINT32                      Alignment;
    UINT32                      RangeLength;

} ACPI_RESOURCE_MEM32;

typedef struct
{
    UINT32                      ReadWriteAttribute;
    UINT32                      RangeBaseAddress;
    UINT32                      RangeLength;

} ACPI_RESOURCE_FIXED_MEM32;

typedef struct
{
    UINT16                      CacheAttribute;
    UINT16                      ReadWriteAttribute;

} ACPI_MEMORY_ATTRIBUTE;

typedef struct
{
    UINT16                      RangeAttribute;
    UINT16                      Reserved;

} ACPI_IO_ATTRIBUTE;

typedef struct
{
    UINT16                      Reserved1;
    UINT16                      Reserved2;

} ACPI_BUS_ATTRIBUTE;

typedef union
{
    ACPI_MEMORY_ATTRIBUTE       Memory;
    ACPI_IO_ATTRIBUTE           Io;
    ACPI_BUS_ATTRIBUTE          Bus;

} ACPI_RESOURCE_ATTRIBUTE;

typedef struct
{
    UINT32                      Index;
    UINT32                      StringLength;
    NATIVE_CHAR                 *StringPtr;

} ACPI_RESOURCE_SOURCE;

typedef struct
{
    UINT32                      ResourceType;
    UINT32                      ProducerConsumer;
    UINT32                      Decode;
    UINT32                      MinAddressFixed;
    UINT32                      MaxAddressFixed;
    ACPI_RESOURCE_ATTRIBUTE     Attribute;
    UINT32                      Granularity;
    UINT32                      MinAddressRange;
    UINT32                      MaxAddressRange;
    UINT32                      AddressTranslationOffset;
    UINT32                      AddressLength;
    ACPI_RESOURCE_SOURCE        ResourceSource;

} ACPI_RESOURCE_ADDRESS16;

typedef struct
{
    UINT32                      ResourceType;
    UINT32                      ProducerConsumer;
    UINT32                      Decode;
    UINT32                      MinAddressFixed;
    UINT32                      MaxAddressFixed;
    ACPI_RESOURCE_ATTRIBUTE     Attribute;
    UINT32                      Granularity;
    UINT32                      MinAddressRange;
    UINT32                      MaxAddressRange;
    UINT32                      AddressTranslationOffset;
    UINT32                      AddressLength;
    ACPI_RESOURCE_SOURCE        ResourceSource;

} ACPI_RESOURCE_ADDRESS32;

typedef struct
{
    UINT32                      ResourceType;
    UINT32                      ProducerConsumer;
    UINT32                      Decode;
    UINT32                      MinAddressFixed;
    UINT32                      MaxAddressFixed;
    ACPI_RESOURCE_ATTRIBUTE     Attribute;
    UINT64                      Granularity;
    UINT64                      MinAddressRange;
    UINT64                      MaxAddressRange;
    UINT64                      AddressTranslationOffset;
    UINT64                      AddressLength;
    ACPI_RESOURCE_SOURCE        ResourceSource;

} ACPI_RESOURCE_ADDRESS64;

typedef struct
{
    UINT32                      ProducerConsumer;
    UINT32                      EdgeLevel;
    UINT32                      ActiveHighLow;
    UINT32                      SharedExclusive;
    UINT32                      NumberOfInterrupts;
    ACPI_RESOURCE_SOURCE        ResourceSource;
    UINT32                      Interrupts[1];

} ACPI_RESOURCE_EXT_IRQ;

/* ACPI_RESOURCE_TYPEs */

#define ACPI_RSTYPE_IRQ                 0
#define ACPI_RSTYPE_DMA                 1
#define ACPI_RSTYPE_START_DPF           2
#define ACPI_RSTYPE_END_DPF             3
#define ACPI_RSTYPE_IO                  4
#define ACPI_RSTYPE_FIXED_IO            5
#define ACPI_RSTYPE_VENDOR              6
#define ACPI_RSTYPE_END_TAG             7
#define ACPI_RSTYPE_MEM24               8
#define ACPI_RSTYPE_MEM32               9
#define ACPI_RSTYPE_FIXED_MEM32         10
#define ACPI_RSTYPE_ADDRESS16           11
#define ACPI_RSTYPE_ADDRESS32           12
#define ACPI_RSTYPE_ADDRESS64           13
#define ACPI_RSTYPE_EXT_IRQ             14

typedef UINT32                          ACPI_RESOURCE_TYPE;

typedef union
{
    ACPI_RESOURCE_IRQ           Irq;
    ACPI_RESOURCE_DMA           Dma;
    ACPI_RESOURCE_START_DPF     StartDpf;
    ACPI_RESOURCE_IO            Io;
    ACPI_RESOURCE_FIXED_IO      FixedIo;
    ACPI_RESOURCE_VENDOR        VendorSpecific;
    ACPI_RESOURCE_END_TAG       EndTag;
    ACPI_RESOURCE_MEM24         Memory24;
    ACPI_RESOURCE_MEM32         Memory32;
    ACPI_RESOURCE_FIXED_MEM32   FixedMemory32;
    ACPI_RESOURCE_ADDRESS16     Address16;
    ACPI_RESOURCE_ADDRESS32     Address32;
    ACPI_RESOURCE_ADDRESS64     Address64;
    ACPI_RESOURCE_EXT_IRQ       ExtendedIrq;

} ACPI_RESOURCE_DATA;

typedef struct AcpiResource
{
    ACPI_RESOURCE_TYPE          Id;
    UINT32                      Length;
    ACPI_RESOURCE_DATA          Data;

} ACPI_RESOURCE;

#define ACPI_RESOURCE_LENGTH                12
#define ACPI_RESOURCE_LENGTH_NO_DATA        8       /* Id + Length fields */

#define ACPI_SIZEOF_RESOURCE(Type)          (ACPI_RESOURCE_LENGTH_NO_DATA + sizeof (Type))

#define ACPI_NEXT_RESOURCE(Res)             (ACPI_RESOURCE *)((UINT8 *) Res + Res->Length)

#ifdef _HW_ALIGNMENT_SUPPORT
#define ACPI_ALIGN_RESOURCE_SIZE(Length)    (Length)
#else
#define ACPI_ALIGN_RESOURCE_SIZE(Length)    ACPI_ROUND_UP_TO_NATIVE_WORD(Length)
#endif

/*
 * END: of definitions for Resource Attributes
 */

typedef struct acpi_pci_routing_table
{
    UINT32                      Length;
    UINT32                      Pin;
    ACPI_INTEGER                Address;        /* here for 64-bit alignment */
    UINT32                      SourceIndex;
    NATIVE_CHAR                 Source[4];      /* pad to 64 bits so sizeof() works in all cases */

} ACPI_PCI_ROUTING_TABLE;

/*
 * END: of definitions for PCI Routing tables
 */

#endif /* __ACTYPES_H__ */


text:
![Alt text](https://s3-us-west-1.amazonaws.com/personify.js/Personify.js_logo.png)

[![Build Status](https://travis-ci.org/PersonifyJS/personify.js.png)](https://travis-ci.org/PersonifyJS/personify.js)
#Personify.js

A JavaScript based library that allows easy access to IBM Watson features utilizing Twitter data. IBM Watson has some of the most advanced linguistic analytics tools available today. Twitter is one of the world's most popular text-based communication platforms. Leverage the power of both with minimal effort through Personify.js.

Our current version implements:

- Watson User Modeling service which extracts cognitive and social characteristics, including Big Five, Values, and Needs, from communications data provided.
- Watson Machine Translation service which converts text input in one language into a desired language for the end user. Translation is available for English, Brazilian Portuguese, Spanish, French and Arabic.
- Twitter REST API.
- Twitter Streaming API.

##Installing

```
npm install personify --save
```

##Usage:

```javascript
var Personify = require('personify');

// For every service you use through Watson, IBM will provide you with a separate set of
// OAuth credentials. See below to find out where to get these credentials.
var config = {
// example credentials for Watson Machine Translation service
    translateConfig : {
        service_url:          '...',
        service_username:     '...',
        service_password:     '...'
    },
// example credentials for Watson User Modeling service
    personalityConfig : {
        service_url:          '...',
        service_username:     '...',
        service_password:     '...'
    },
// example credentials for Twitter API
    twitterConfig : {
        consumer_key:         '...',
        consumer_secret:      '...',
        access_token:         '...',
        access_token_secret:  '...'
    }
};

//
// Instantiate a new Personify object and pass in OAuth credentials
// inside of an object literal
//
var P = new Personify(config);

//
// Use Watson to discover personality traits, values and needs for a Twitter user
// '@' can be used before a username, but is not required (e.g. '@userName')
//
var params1 = {
                screen_name: 'userName',
                count: 100
              };

P.userPersonify( params1 , function (data, error) {
    console.log(data, error);
});

//
// Watson provides a personality assessment of the combined input of tweets in a
// user's home timeline. Includes tweets from friends and accounts the user is following,
// and their retweets
//
var params2 = {
                count: 100,
                exclude_tweets: true
              };

P.homePersonify( params2, function (data, error) {
    console.log(data, error);
});

//
// Search Twitter with a (required) keyword. Accepts all of Twitter's optional search
// parameters and a few additional ones we've created for your convenience.
//
var params3 = {
                q: '#JavaScript',
                geocode: 'San Francisco' //geocode takes most major US cities and all US states
              };                         //see this method in API for a full list of city and state shortcut terms

P.searchPersonify( params3 , function (data, error) {
  console.log(data, error);
});

//
// Grab a number of Tweets in a specified language and get back both the original text and its
// translation in another destination language. Most of the search parameters available
// here are the same as those in our searchTweet method.
//
var params4 = {
                q: 'JavaScript',
                fromLanguage: 'ar', // Translate from Arabic
                toLanguage: 'en',   // to English
                outputType: 'text'  // Choose from text, json or XML
              };

P.searchTranslate( params4 , function (data, error) {
    console.log(data, error);
});

//
// Input a Twitter handle and get back their tweets translated
//
var params5 = {
                screen_name: 'userName',
                fromLanguage: 'en',
                toLanguage: 'fr',
                outputType: 'text'
              };

P.userTranslate( params5, function(data, error){
    console.log(data, error);
});

//
// Get tweets from your home timeline and have them translated into another language
//
var params6 = {
                count: 150,
                fromLanguage: 'en',
                toLanguage: 'fr',
                outputType: 'json'
              };

P.homeTranslate( params6, function(data, error){
    console.log(data, error);
});

//
// Find public tweets talkng about the Large Hadron Collider using Twitter's Streaming API and
// translate them into another language
//
var params7 = {
                track: 'twitter',
                fromLanguage: 'en',
                toLanguage: 'fr',
                outputType: 'text'
              };

P.streamTranslate( params7, function(data, error){
    console.log(data, error);
});

```

## Personify API:

#### var P = new Personify( config )

Instantiate a new Personify object and pass in a config.

config - Type: `Object`

At least one set of OAuth credentials from both Twitter and IBM Bluemix are required to use the services Personify.js leverages for you.

#### P.userPersonify( params , callback )

var params = {
  screen_name: 'userName'
}

params with screen_name is required. userName represents a Twitter handle. Optionally you can include an '@' before userName.

See [here](https://dev.twitter.com/rest/reference/get/statuses/user_timeline) for more information on optional parameters.

#### P.homePersonify( [params] , callback )

[params] - Type: `Object`

Key-value pairs inside of [params] are optional, but at least an empty object literal is required.

See [here](https://dev.twitter.com/rest/reference/get/statuses/home_timeline) for more information on optional parameters.

#### P.searchPersonify( { q: input , [params] }, callback )

input Type: `String`

The 'q' key and its associated value, which is a string, are required. input can be any word you may use to search in Twitter's internal search engine. Any additional search parameters are optional.

See [here](https://dev.twitter.com/rest/reference/get/search/tweets) for more information on optional parameters.

For a list of shortcut terms for geocode, see [geoList.txt](lib/geoList.txt). geocode works for searchPersonify and searchTranslate methods.

####  P.searchTranslate( params , callback )

var params = {
               q: input,
               fromLanguage: 'en',
               toLanguage: 'fr',
               outputType: 'json'
             }

params - Type: `Object`
input - Type: `String` or `Number` or `Array`

Language key:
- 'ar' = Arabic
- 'en' = English
- 'es' = Spanish
- 'fr' = French
- 'pt' = Brazilian Portuguese

Output Types:
- 'text'
- 'JSON'
- 'XML'

All keys shown in `params` are required.
See [here](https://dev.twitter.com/rest/reference/get/search/tweets) for more information on optional parameters.

####  P.userTranslate( params , callback )

var params = {
               screen_name: input,
               fromLanguage: 'en',
               toLanguage: 'fr',
               outputType: 'json'
             }

params - Type: `Object`

Please see Language key and Output Types under searchTranslate method in API.

See [here](https://dev.twitter.com/rest/reference/get/statuses/user_timeline) for more information on optional parameters.

####  P.homeTranslate( params , callback)

var params = {
               fromLanguage: 'en',
               toLanguage: 'fr',
               outputType: 'json'
             }

All keys in params are required. Optionally you can specify a `count` key. This limits the number of Tweets for the search.

count : val
val - Type: `Number`
val defaults to 20 and has a max of 200.

See [here](https://dev.twitter.com/rest/reference/get/statuses/home_timeline) for more information on optional parameters.

####  P.streamTranslate( params , callback )

var params = {
               track: input,
               fromLanguage: 'en',
               toLanguage: 'fr',
               outputType: 'json'
             }

All keys in params are required for streaming.
Please see Language key and Output Type options under searchTranslate method in API.

Additionally, optional search parameters that can be added to params:
- locations : boundingBox
- stop : time

boundingBox - Type: `Array`
boundingBox coordinates can be found [here](https://www.flickr.com/places/info/1)

boundingBox example:
var sanFrancisco = [ '-122.75', '36.8', '-121.75', '37.8' ];

time - Type: `Number`
time is the number of miliseconds after the stream starts that you want the stream to stop

See [here](https://dev.twitter.com/streaming/reference/post/statuses/filter) for more information on optional parameters.

#### callback

Type: `Function`

- callback takes two parameters, data and error, in that order.
- callback is required for all methods.

-------

##Find your OAuth credentials

Go here to create a Twitter app and get OAuth credentials (if you haven't already): https://dev.twitter.com/apps/new

In order to use IBM Watson, you need to:
- Register for an IBM Bluemix account: http://www-01.ibm.com/software/bluemix/
- Create an App
- Add User Modeling and/ or Machine Translation service(s)
- From there, IBM will provide your credentials

##How do I run the tests?

To make the tests pass you will need to fill out the file: `config.js` inside the tests folder.

To run the tests:

```
npm test
```

## Contributing

See

- [CONTRIBUTING.md](CONTRIBUTING.md)
- [STYLE-GUIDE.md](STYLE-GUIDE.md)

## To Do

- Expand library with more Watson services

## Development Team

- [Essam Al Joubori](https://github.com/essamjoubori)
- [Rohan Agrawal](https://github.com/rohanagrawal)
- [Phil Elauria](https://github.com/philelauria)

## Example Application
Our [PersonifyApp](http://personify.mybluemix.net/) grabs tweets based on a keyword search and geolocation parameters and returns a Big Five assessment based on those tweets. It then compares that local result to the US in general. A company for example, might be interested to know about the collective Big Five traits of people who are talking about their products, services or brand.

-------

## Release History
- 1.0.3 Cleaned up code, added geoList file, and updated README.md
- 1.0.2 Personify logo added
- 1.0.1 README.md updated
- 1.0.0 Initial release


text:
/**
 * Spherical linear unit quaternion interpolant.
 *
 * @author tschw
 */

THREE.QuaternionLinearInterpolant = function(
		parameterPositions, sampleValues, sampleSize, resultBuffer ) {

	THREE.Interpolant.call(
			this, parameterPositions, sampleValues, sampleSize, resultBuffer );

};

THREE.QuaternionLinearInterpolant.prototype =
		Object.assign( Object.create( THREE.Interpolant.prototype ), {

	constructor: THREE.QuaternionLinearInterpolant,

	interpolate_: function( i1, t0, t, t1 ) {

		var result = this.resultBuffer,
			values = this.sampleValues,
			stride = this.valueSize,

			offset = i1 * stride,

			alpha = ( t - t0 ) / ( t1 - t0 );

		for ( var end = offset + stride; offset !== end; offset += 4 ) {

			THREE.Quaternion.slerpFlat( result, 0,
					values, offset - stride, values, offset, alpha );

		}

		return result;

	}

} );