Download as
Browse Code »

Commit 01eee1c3d55044cb0c0ee84c3edd65adde52cd0e

Authored by bruno
1 parent c1311c7c
Exists in master

Adicionando documentação

Showing 11 changed files with 489 additions and 18 deletions   Show diff stats
Makefile
  Diff comments   View file @01eee1c
... ... @@ -75,4 +75,4 @@ test-plugin:
75 75  
76 76 #Gera documentação
77 77 doc:
78   -
  78 + doxygen doc_config
... ...
... ... @@ -1,8 +0,0 @@
1   -############################## README VLIBRAS ##############################
2   -# #
3   -# Bruno Santos #
4   -# brunosantos@lavid.ufpb.br #
5   -# Repositório do sistema VLibras-Core para a plataforma Windows #
6   -############################################################################
7   -
8   -
README.md 0 → 100644
  Diff comments   View file @01eee1c
... ... @@ -0,0 +1,60 @@
  1 +# Mais informações
  2 +
  3 + Para mais informações visite nossa página clicando
  4 + [aqui!](http:\\vlibrasplayer.lavid.ufpb.br)
  5 +
  6 +
  7 +
  8 +@mainpage Documentação VLibras Desktop
  9 +# Overview
  10 + Este documento tem como principal objetivo, oferecer uma visão simples da arquitetura do
  11 +software VLibras desktop, versão Windows, para melhor entendimento do seu funcionamento.
  12 +
  13 +
  14 +Como Ilustrado na figura abaixo, o player utiliza as funcionalidades do plugin, são elas:
  15 +
  16 +1. coreInitialize
  17 +2. coreExecute
  18 +3. coreFinalize
  19 +
  20 +O plugin é uma biblioteca de ligação dinâmica (dll), responsável por fazer a comunicação
  21 +entre o sistema operacional e o tradutor, e entre o tradutor e o player. Para fazer essa comunicação
  22 +ele utiliza as classes PyTradutor e PyClip, que são implementadas na linguagem C++.
  23 +Essas classes importam a lib python.h para ter acesso aos módulos de
  24 +tradução(PortGlosa.py) e clipboard(Clipboard.py) implementados na linguagem Python.
  25 +Os executáveis Bdrag e hunpos-tag servem para fazer a cópia automática da seleção do
  26 +mouse para área de transferência do sistema operacional e classificar as palavras do texto
  27 +selecionado, respectivamente.
  28 +
  29 +![overview](..\..\workflow\visao geral da arquitetura.png)
  30 +
  31 +
  32 +# CoreInitialize
  33 +
  34 +
  35 +Esse método apenas instancia os objetos da classe PyTradutor e PyClip, e inicializa a
  36 +aplicação Bdrag que permanecerá executando durante toda a execução do VLibras.
  37 +
  38 +
  39 +
  40 +![overview](..\..\workflow\coreInitialize.png)
  41 +
  42 +
  43 +
  44 +# CoreExecute
  45 +
  46 +Esse método é responsável por:
  47 +1. Copiar a área de transferência para uma variável que será usada na tradução
  48 +2. Traduzir o texto selecionado de português para glosa
  49 +3. Enviar a glosa para o player para que ele possa importar e interpolar as animações
  50 +
  51 +![overview](..\..\workflow\coreExecute.png)
  52 +
  53 +
  54 +# coreFinalize
  55 +
  56 +
  57 +Esse método apenas finaliza as instancias criadas e encerra a aplicação Bdrag.
  58 +
  59 +
  60 +![overview](..\..\workflow\coreFinalize.png)
0 61 \ No newline at end of file
... ...
doc_config 0 → 100644
  Diff comments   View file @01eee1c
... ... @@ -0,0 +1,367 @@
  1 +# Doxyfile 1.8.9.1
  2 +
  3 +#---------------------------------------------------------------------------
  4 +# Project related configuration options
  5 +#---------------------------------------------------------------------------
  6 +DOXYFILE_ENCODING = UTF-8
  7 +PROJECT_NAME = "VLibras Desktop Windows"
  8 +PROJECT_NUMBER = beta
  9 +PROJECT_BRIEF = "Traduçao de Português para LIBRAS"
  10 +PROJECT_LOGO = C:/Users/bruno/Desktop/user_install/icons/icon_vlibras.ico
  11 +OUTPUT_DIRECTORY = C:/Users/bruno/vlibras-core-win/doc
  12 +CREATE_SUBDIRS = NO
  13 +ALLOW_UNICODE_NAMES = NO
  14 +OUTPUT_LANGUAGE = Brazilian
  15 +BRIEF_MEMBER_DESC = YES
  16 +REPEAT_BRIEF = YES
  17 +ABBREVIATE_BRIEF = "The $name class" \
  18 + "The $name widget" \
  19 + "The $name file" \
  20 + is \
  21 + provides \
  22 + specifies \
  23 + contains \
  24 + represents \
  25 + a \
  26 + an \
  27 + the
  28 +ALWAYS_DETAILED_SEC = NO
  29 +INLINE_INHERITED_MEMB = NO
  30 +FULL_PATH_NAMES = YES
  31 +STRIP_FROM_PATH =
  32 +STRIP_FROM_INC_PATH =
  33 +SHORT_NAMES = NO
  34 +JAVADOC_AUTOBRIEF = NO
  35 +QT_AUTOBRIEF = NO
  36 +MULTILINE_CPP_IS_BRIEF = NO
  37 +INHERIT_DOCS = YES
  38 +SEPARATE_MEMBER_PAGES = NO
  39 +TAB_SIZE = 4
  40 +ALIASES =
  41 +TCL_SUBST =
  42 +OPTIMIZE_OUTPUT_FOR_C = NO
  43 +OPTIMIZE_OUTPUT_JAVA = NO
  44 +OPTIMIZE_FOR_FORTRAN = NO
  45 +OPTIMIZE_OUTPUT_VHDL = NO
  46 +EXTENSION_MAPPING =
  47 +MARKDOWN_SUPPORT = YES
  48 +AUTOLINK_SUPPORT = YES
  49 +BUILTIN_STL_SUPPORT = NO
  50 +CPP_CLI_SUPPORT = NO
  51 +SIP_SUPPORT = NO
  52 +IDL_PROPERTY_SUPPORT = YES
  53 +DISTRIBUTE_GROUP_DOC = NO
  54 +SUBGROUPING = YES
  55 +INLINE_GROUPED_CLASSES = NO
  56 +INLINE_SIMPLE_STRUCTS = NO
  57 +TYPEDEF_HIDES_STRUCT = NO
  58 +LOOKUP_CACHE_SIZE = 0
  59 +#---------------------------------------------------------------------------
  60 +# Build related configuration options
  61 +#---------------------------------------------------------------------------
  62 +EXTRACT_ALL = NO
  63 +EXTRACT_PRIVATE = NO
  64 +EXTRACT_PACKAGE = NO
  65 +EXTRACT_STATIC = NO
  66 +EXTRACT_LOCAL_CLASSES = YES
  67 +EXTRACT_LOCAL_METHODS = NO
  68 +EXTRACT_ANON_NSPACES = NO
  69 +HIDE_UNDOC_MEMBERS = NO
  70 +HIDE_UNDOC_CLASSES = NO
  71 +HIDE_FRIEND_COMPOUNDS = NO
  72 +HIDE_IN_BODY_DOCS = NO
  73 +INTERNAL_DOCS = NO
  74 +CASE_SENSE_NAMES = NO
  75 +HIDE_SCOPE_NAMES = NO
  76 +HIDE_COMPOUND_REFERENCE= NO
  77 +SHOW_INCLUDE_FILES = YES
  78 +SHOW_GROUPED_MEMB_INC = NO
  79 +FORCE_LOCAL_INCLUDES = NO
  80 +INLINE_INFO = YES
  81 +SORT_MEMBER_DOCS = YES
  82 +SORT_BRIEF_DOCS = NO
  83 +SORT_MEMBERS_CTORS_1ST = NO
  84 +SORT_GROUP_NAMES = NO
  85 +SORT_BY_SCOPE_NAME = NO
  86 +STRICT_PROTO_MATCHING = NO
  87 +GENERATE_TODOLIST = YES
  88 +GENERATE_TESTLIST = YES
  89 +GENERATE_BUGLIST = YES
  90 +GENERATE_DEPRECATEDLIST= YES
  91 +ENABLED_SECTIONS =
  92 +MAX_INITIALIZER_LINES = 30
  93 +SHOW_USED_FILES = YES
  94 +SHOW_FILES = YES
  95 +SHOW_NAMESPACES = YES
  96 +FILE_VERSION_FILTER =
  97 +LAYOUT_FILE =
  98 +CITE_BIB_FILES =
  99 +#---------------------------------------------------------------------------
  100 +# Configuration options related to warning and progress messages
  101 +#---------------------------------------------------------------------------
  102 +QUIET = NO
  103 +WARNINGS = YES
  104 +WARN_IF_UNDOCUMENTED = YES
  105 +WARN_IF_DOC_ERROR = YES
  106 +WARN_NO_PARAMDOC = NO
  107 +WARN_FORMAT = "$file:$line: $text"
  108 +WARN_LOGFILE =
  109 +#---------------------------------------------------------------------------
  110 +# Configuration options related to the input files
  111 +#---------------------------------------------------------------------------
  112 +INPUT = src\ include\ plugin\ README.md
  113 +INPUT_ENCODING = UTF-8
  114 +FILE_PATTERNS = *.c \
  115 + *.cc \
  116 + *.cxx \
  117 + *.cpp \
  118 + *.c++ \
  119 + *.java \
  120 + *.ii \
  121 + *.ixx \
  122 + *.ipp \
  123 + *.i++ \
  124 + *.inl \
  125 + *.idl \
  126 + *.ddl \
  127 + *.odl \
  128 + *.h \
  129 + *.hh \
  130 + *.hxx \
  131 + *.hpp \
  132 + *.h++ \
  133 + *.cs \
  134 + *.d \
  135 + *.php \
  136 + *.php4 \
  137 + *.php5 \
  138 + *.phtml \
  139 + *.inc \
  140 + *.m \
  141 + *.markdown \
  142 + *.md \
  143 + *.mm \
  144 + *.dox \
  145 + *.py \
  146 + *.f90 \
  147 + *.f \
  148 + *.for \
  149 + *.tcl \
  150 + *.vhd \
  151 + *.vhdl \
  152 + *.ucf \
  153 + *.qsf \
  154 + *.as \
  155 + *.js
  156 +RECURSIVE = YES
  157 +EXCLUDE =
  158 +EXCLUDE_SYMLINKS = NO
  159 +EXCLUDE_PATTERNS =
  160 +EXCLUDE_SYMBOLS =
  161 +EXAMPLE_PATH =
  162 +EXAMPLE_PATTERNS = *
  163 +EXAMPLE_RECURSIVE = NO
  164 +IMAGE_PATH =
  165 +INPUT_FILTER =
  166 +FILTER_PATTERNS =
  167 +FILTER_SOURCE_FILES = NO
  168 +FILTER_SOURCE_PATTERNS =
  169 +USE_MDFILE_AS_MAINPAGE =
  170 +#---------------------------------------------------------------------------
  171 +# Configuration options related to source browsing
  172 +#---------------------------------------------------------------------------
  173 +SOURCE_BROWSER = NO
  174 +INLINE_SOURCES = NO
  175 +STRIP_CODE_COMMENTS = YES
  176 +REFERENCED_BY_RELATION = NO
  177 +REFERENCES_RELATION = NO
  178 +REFERENCES_LINK_SOURCE = YES
  179 +SOURCE_TOOLTIPS = YES
  180 +USE_HTAGS = NO
  181 +VERBATIM_HEADERS = YES
  182 +CLANG_ASSISTED_PARSING = NO
  183 +CLANG_OPTIONS =
  184 +#---------------------------------------------------------------------------
  185 +# Configuration options related to the alphabetical class index
  186 +#---------------------------------------------------------------------------
  187 +ALPHABETICAL_INDEX = YES
  188 +COLS_IN_ALPHA_INDEX = 5
  189 +IGNORE_PREFIX =
  190 +#---------------------------------------------------------------------------
  191 +# Configuration options related to the HTML output
  192 +#---------------------------------------------------------------------------
  193 +GENERATE_HTML = YES
  194 +HTML_OUTPUT = html
  195 +HTML_FILE_EXTENSION = .html
  196 +HTML_HEADER =
  197 +HTML_FOOTER =
  198 +HTML_STYLESHEET =
  199 +HTML_EXTRA_STYLESHEET =
  200 +HTML_EXTRA_FILES =
  201 +HTML_COLORSTYLE_HUE = 220
  202 +HTML_COLORSTYLE_SAT = 100
  203 +HTML_COLORSTYLE_GAMMA = 80
  204 +HTML_TIMESTAMP = YES
  205 +HTML_DYNAMIC_SECTIONS = NO
  206 +HTML_INDEX_NUM_ENTRIES = 100
  207 +GENERATE_DOCSET = NO
  208 +DOCSET_FEEDNAME = "Doxygen generated docs"
  209 +DOCSET_BUNDLE_ID = org.doxygen.Project
  210 +DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  211 +DOCSET_PUBLISHER_NAME = Publisher
  212 +GENERATE_HTMLHELP = NO
  213 +CHM_FILE =
  214 +HHC_LOCATION =
  215 +GENERATE_CHI = NO
  216 +CHM_INDEX_ENCODING =
  217 +BINARY_TOC = NO
  218 +TOC_EXPAND = NO
  219 +GENERATE_QHP = NO
  220 +QCH_FILE =
  221 +QHP_NAMESPACE = org.doxygen.Project
  222 +QHP_VIRTUAL_FOLDER = doc
  223 +QHP_CUST_FILTER_NAME =
  224 +QHP_CUST_FILTER_ATTRS =
  225 +QHP_SECT_FILTER_ATTRS =
  226 +QHG_LOCATION =
  227 +GENERATE_ECLIPSEHELP = NO
  228 +ECLIPSE_DOC_ID = org.doxygen.Project
  229 +DISABLE_INDEX = NO
  230 +GENERATE_TREEVIEW = NO
  231 +ENUM_VALUES_PER_LINE = 4
  232 +TREEVIEW_WIDTH = 250
  233 +EXT_LINKS_IN_WINDOW = NO
  234 +FORMULA_FONTSIZE = 10
  235 +FORMULA_TRANSPARENT = YES
  236 +USE_MATHJAX = NO
  237 +MATHJAX_FORMAT = HTML-CSS
  238 +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
  239 +MATHJAX_EXTENSIONS =
  240 +MATHJAX_CODEFILE =
  241 +SEARCHENGINE = YES
  242 +SERVER_BASED_SEARCH = NO
  243 +EXTERNAL_SEARCH = NO
  244 +SEARCHENGINE_URL =
  245 +SEARCHDATA_FILE = searchdata.xml
  246 +EXTERNAL_SEARCH_ID =
  247 +EXTRA_SEARCH_MAPPINGS =
  248 +#---------------------------------------------------------------------------
  249 +# Configuration options related to the LaTeX output
  250 +#---------------------------------------------------------------------------
  251 +GENERATE_LATEX = NO
  252 +LATEX_OUTPUT = latex
  253 +LATEX_CMD_NAME = latex
  254 +MAKEINDEX_CMD_NAME = makeindex
  255 +COMPACT_LATEX = NO
  256 +PAPER_TYPE = a4
  257 +EXTRA_PACKAGES =
  258 +LATEX_HEADER =
  259 +LATEX_FOOTER =
  260 +LATEX_EXTRA_STYLESHEET =
  261 +LATEX_EXTRA_FILES =
  262 +PDF_HYPERLINKS = YES
  263 +USE_PDFLATEX = YES
  264 +LATEX_BATCHMODE = NO
  265 +LATEX_HIDE_INDICES = NO
  266 +LATEX_SOURCE_CODE = NO
  267 +LATEX_BIB_STYLE = plain
  268 +#---------------------------------------------------------------------------
  269 +# Configuration options related to the RTF output
  270 +#---------------------------------------------------------------------------
  271 +GENERATE_RTF = NO
  272 +RTF_OUTPUT = rtf
  273 +COMPACT_RTF = NO
  274 +RTF_HYPERLINKS = NO
  275 +RTF_STYLESHEET_FILE =
  276 +RTF_EXTENSIONS_FILE =
  277 +RTF_SOURCE_CODE = NO
  278 +#---------------------------------------------------------------------------
  279 +# Configuration options related to the man page output
  280 +#---------------------------------------------------------------------------
  281 +GENERATE_MAN = NO
  282 +MAN_OUTPUT = man
  283 +MAN_EXTENSION = .3
  284 +MAN_SUBDIR =
  285 +MAN_LINKS = NO
  286 +#---------------------------------------------------------------------------
  287 +# Configuration options related to the XML output
  288 +#---------------------------------------------------------------------------
  289 +GENERATE_XML = NO
  290 +XML_OUTPUT = xml
  291 +XML_PROGRAMLISTING = YES
  292 +#---------------------------------------------------------------------------
  293 +# Configuration options related to the DOCBOOK output
  294 +#---------------------------------------------------------------------------
  295 +GENERATE_DOCBOOK = NO
  296 +DOCBOOK_OUTPUT = docbook
  297 +DOCBOOK_PROGRAMLISTING = NO
  298 +#---------------------------------------------------------------------------
  299 +# Configuration options for the AutoGen Definitions output
  300 +#---------------------------------------------------------------------------
  301 +GENERATE_AUTOGEN_DEF = NO
  302 +#---------------------------------------------------------------------------
  303 +# Configuration options related to the Perl module output
  304 +#---------------------------------------------------------------------------
  305 +GENERATE_PERLMOD = NO
  306 +PERLMOD_LATEX = NO
  307 +PERLMOD_PRETTY = YES
  308 +PERLMOD_MAKEVAR_PREFIX =
  309 +#---------------------------------------------------------------------------
  310 +# Configuration options related to the preprocessor
  311 +#---------------------------------------------------------------------------
  312 +ENABLE_PREPROCESSING = YES
  313 +MACRO_EXPANSION = NO
  314 +EXPAND_ONLY_PREDEF = NO
  315 +SEARCH_INCLUDES = YES
  316 +INCLUDE_PATH =
  317 +INCLUDE_FILE_PATTERNS =
  318 +PREDEFINED =
  319 +EXPAND_AS_DEFINED =
  320 +SKIP_FUNCTION_MACROS = YES
  321 +#---------------------------------------------------------------------------
  322 +# Configuration options related to external references
  323 +#---------------------------------------------------------------------------
  324 +TAGFILES =
  325 +GENERATE_TAGFILE =
  326 +ALLEXTERNALS = NO
  327 +EXTERNAL_GROUPS = YES
  328 +EXTERNAL_PAGES = YES
  329 +PERL_PATH = /usr/bin/perl
  330 +#---------------------------------------------------------------------------
  331 +# Configuration options related to the dot tool
  332 +#---------------------------------------------------------------------------
  333 +CLASS_DIAGRAMS = NO
  334 +MSCGEN_PATH =
  335 +DIA_PATH =
  336 +HIDE_UNDOC_RELATIONS = YES
  337 +HAVE_DOT = NO
  338 +DOT_NUM_THREADS = 0
  339 +DOT_FONTNAME = Helvetica
  340 +DOT_FONTSIZE = 10
  341 +DOT_FONTPATH =
  342 +CLASS_GRAPH = YES
  343 +COLLABORATION_GRAPH = YES
  344 +GROUP_GRAPHS = YES
  345 +UML_LOOK = NO
  346 +UML_LIMIT_NUM_FIELDS = 10
  347 +TEMPLATE_RELATIONS = NO
  348 +INCLUDE_GRAPH = YES
  349 +INCLUDED_BY_GRAPH = YES
  350 +CALL_GRAPH = NO
  351 +CALLER_GRAPH = NO
  352 +GRAPHICAL_HIERARCHY = YES
  353 +DIRECTORY_GRAPH = YES
  354 +DOT_IMAGE_FORMAT = png
  355 +INTERACTIVE_SVG = NO
  356 +DOT_PATH =
  357 +DOTFILE_DIRS =
  358 +MSCFILE_DIRS =
  359 +DIAFILE_DIRS =
  360 +PLANTUML_JAR_PATH =
  361 +PLANTUML_INCLUDE_PATH =
  362 +DOT_GRAPH_MAX_NODES = 50
  363 +MAX_DOT_GRAPH_DEPTH = 0
  364 +DOT_TRANSPARENT = NO
  365 +DOT_MULTI_TARGETS = NO
  366 +GENERATE_LEGEND = YES
  367 +DOT_CLEANUP = YES
... ...
include/pyClip.h
  Diff comments   View file @01eee1c
1 1 //*****************************************************************
2 2 /*
3   -VLibras: Automatic contents translator from Portuguese to LIBRAS
  3 +VLibras: Tradução de Português para LIBRAS
4 4  
5   -Copyright (c) 2015 Bruno santos
6   -VLibras-Core group at LAViD, Federal University of Paraiba
  5 +Bruno santos
  6 +VLibras-Core
  7 +2015
7 8 */
8 9 //*****************************************************************
9 10  
10 11 /**
11   -* \file pyClip.cpp
  12 +* \file pyClip.h
12 13 * \authors Bruno Santos
13 14 * \date Janeiro 2015
14 15 */
... ... @@ -18,6 +19,11 @@ VLibras-Core group at LAViD, Federal University of Paraiba
18 19  
19 20 #include "Python.h"
20 21  
  22 +/** \brief Classe para copiar área de Transferência do sistema operacional.
  23 +*
  24 +* Essa classe permite copiar todo conteúdo salvo na área de transferência do sistema operacional,
  25 +* permitindo sua utilização numa aplicação C++.
  26 +*/
21 27 class PyClip
22 28 {
23 29 private:
... ... @@ -30,11 +36,42 @@ class PyClip
30 36 PyObject * pArgs;
31 37 PyObject * pResult;
32 38 public:
33   - PyClip();
34   - ~PyClip();
35   - char* clip();
36   - void bdragOn();
37   - void bdragOff();
  39 +
  40 +/** \brief O construtor da classe.
  41 +*
  42 +* O construtor inicia o ambiente Python para copiar os textos salvos na área de transferência do sistema operacional.
  43 +*/
  44 + PyClip();
  45 +
  46 +/** \brief O Destrutor da classe.
  47 +*
  48 +* O Destrutor finaliza o ambiente Python montado para execução da cópia.
  49 +*/
  50 + ~PyClip();
  51 +
  52 +/** \brief Cópia da área de Transferência.
  53 +*
  54 +* Esse método permite copiar o conteúdo da área de Transferência.
  55 +* \param void
  56 +* \return Ponteiro para char com o texto copiado, caso o conteúdo copiado não seja texto, exibe a mensagem: "ESCOLHER TEXTO CERTO".
  57 +*/
  58 + char* clip();
  59 +
  60 +/** \brief Inicia Bdrag
  61 +*
  62 +* Esse método inicia a aplicação Bdrag, que é responsável por copiar a seleção do mouse automaticamente para área de transferência.
  63 +* \param void
  64 +* \return void
  65 +*/
  66 + void bdragOn();
  67 +
  68 +/** \brief Finaliza Bdrag
  69 +*
  70 +* Esse método finaliza a aplicação Bdrag, que é responsável por copiar a seleção do mouse automaticamente para área de transferência.
  71 +* \param void
  72 +* \return void
  73 +*/
  74 + void bdragOff();
38 75 };
39 76  
40 77 #endif
... ...
plugin/corePlugin.h
  Diff comments   View file @01eee1c
  1 +//*****************************************************************
  2 +/*
  3 +VLibras: Plugin para integração com Unity
  4 +
  5 +Bruno santos
  6 +VLibras-Core
  7 +2015
  8 +*/
  9 +//*****************************************************************
  10 +
  11 +/**
  12 +* \file corePlugin.h
  13 +* \authors Bruno Santos
  14 +* \date Janeiro 2015
  15 +*/
1 16 #ifndef _COREPLUGIN_H
2 17 #define _COREPLUGIN_H
3 18  
... ...
workflow/coreExecute.png 0 → 100644
View file @01eee1c

37.3 KB
workflow/coreFinalize.png 0 → 100644
View file @01eee1c

26.3 KB
workflow/coreInitialize.png 0 → 100644
View file @01eee1c

26.6 KB
workflow/icon_vlibras.ico 0 → 100644
View file @01eee1c
No preview for this file type
workflow/visao geral da arquitetura.png 0 → 100644
View file @01eee1c

39.5 KB