Scripting

You can extend Lattix through its powerful scripting capabilities. These scripts can be used for custom analysis, integration with other products, build and test automation, and for creating new Lattix modules.

A script catalog contains a number of scripts that have already been developed. These scripts should also serve as examples of how you can access the Lattix API. Lattix script are written in Groovy which is super-set of the Java language. Therefore, if you already know Java then you can begin writing scripts right away. A script can be run from Lattix Architect or LDC (LDCScript).

• Installing and Running Scripts
  • Installing a Script
  • Running a Script from ldm
  • Running a Script using ldcscript
• Scripting with Groovy
  • Introduction
  • Specifying Actions
    • Simple Scripts with a One Action and no Arguments:
    • Script with Multiple Actions:
    • Script with Action that takes Arguments:
  • Script Annotations
    • @Action
    • @Arg
    • @Cancelable
    • @ClassPath
    • @Description
    • @Keyword
    • @Localize
    • @Report
    • @RequiresVersion
    • @ScriptDescription
    • @Shortcut
  • Key Interfaces of the API
    • Builtin Methods
    • Key Classes
      • Project Model
      • Atom
      • DependencyEdge
      • Partition
      • Tag
  • Example Scripts
    • Iterate through all Subsystems
    • Create New Project from Visual Studio Solution File using Clang module
    • Create Rule on selection
    • Expand/collapse hierarchical expansion
    • Extract Metrics
    • Dump Dependencies for Selected Subsystem into File
    • Custom Report: Generate File Name and Line Number of each Violation
    • Custom Report: Uses (inherits) report with Line Numbers
    • Custom Report: Uses report with Line Numbers
    • Custom Metric
    • Custom Metric using partition properties
    • Expand Members
    • Partitioning Algorithms
      • Apply one of the current Partitioning Algorithms to selected partition
    • Custom Partitioning Algorithms
  • API Reference
  • QueryBuilder API
    • Examples
      • Find atoms in which the atom name contains the string “work”
      • Find edges in which the target atom name contains the string “test”
      • Find partitions in which the display name ends with the string “.h”
      • Find partitions in which the display name ends with the string “.h” and the partition contains an atom that has a property test=”true”
    • IQueryBuilder
    • IAtomKinds
    • IAtoms
    • ICycleComponents
    • ICycles
    • IDatasource
    • IDependency
    • IDependencyKinds
    • IEdgeDetails
    • IEdges
    • IMetricDefinitions
    • IMetrics
    • IModules
    • IPartitionRelations
    • IPartitions
    • IProperties
    • IPropertyDefinitions
    • IRules
    • ITags
    • IViolators
    • IWorkList
    • Select
    • Table
    • Where
  • Script Editor Tool
    • Before You Start
    • Setting Up Editor
    • Debugging Scripts
    • Troubleshooting
• Script Catalog
  • List of Currently Available Scripts
    • Android JNI
    • Collapse Partition
    • Combine Partitions for Source and Header Files
    • Combine Partitions for Source and Header Files Per Folder
    • Create Work Item From Violation
    • Data Coupling Report
    • Delete Partitions with Atoms
    • Dump Dependencies for Selected Subsystem
    • Dump Model Kinds
    • Export Project Atoms to Excel / LDI
    • Find Archive to Archive Dependencies
    • Flatten Selected Partitions
    • Generate Class View
    • Generate Excel/LDI from Project
    • Graph Elements listed in File with GraphViz
    • Graph Selected Subsystem with Graphviz
    • Graph Selected Subsystem with Pajek
    • Graph Subsystems with Hierarchy
    • Import/Export Rules
    • Infer Dependency to Methods in Concrete Class
    • Inferred Dependencies
    • Jira Issue
      • Configure JIRA connection
      • Create JIRA issue
    • List Dependency Paths
    • Load Partition Properties
      • Example with file_properties
      • Example with partition_properties
    • Open Project
    • Organize Project
      • Input Parameters
      • Input File Formats
    • Remove Selected Atom Kinds
    • Resolve .NET to C/C++
    • Save Project
    • Tag Elements listed in File