├── .gitattributes ├── .gitignore ├── Digital.jar ├── LICENSE ├── README.md ├── pom.xml └── src ├── main ├── dig │ └── jarLibTest.dig ├── java │ └── de │ │ └── neemann │ │ └── digital │ │ └── plugin │ │ ├── DemoComponentSource.java │ │ ├── MultiNot.java │ │ ├── MultiPortRAM.java │ │ ├── MyAnd.java │ │ ├── MyOr.java │ │ ├── MyOrShape.java │ │ └── package-info.java └── resources │ └── vhdl │ └── DIG_MyAnd.tem └── test └── java └── de └── neemann └── digital └── plugin └── MyComponentsTest.java /.gitattributes: -------------------------------------------------------------------------------- 1 | *.java text eol=lf 2 | *.xml text eol=lf 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by .ignore support plugin (hsz.mobi) 2 | ### Java template 3 | *.class 4 | 5 | # Mobile Tools for Java (J2ME) 6 | .mtj.tmp/ 7 | 8 | # Package Files # 9 | *.war 10 | *.ear 11 | 12 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 13 | hs_err_pid* 14 | ### JetBrains template 15 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio 16 | 17 | *.iml 18 | 19 | ## Directory-based project format: 20 | .idea/ 21 | # if you remove the above rule, at least ignore the following: 22 | 23 | # User-specific stuff: 24 | # .idea/workspace.xml 25 | # .idea/tasks.xml 26 | # .idea/dictionaries 27 | 28 | # Sensitive or high-churn files: 29 | # .idea/dataSources.ids 30 | # .idea/dataSources.xml 31 | # .idea/sqlDataSources.xml 32 | # .idea/dynamic.xml 33 | # .idea/uiDesigner.xml 34 | 35 | # Gradle: 36 | # .idea/gradle.xml 37 | # .idea/libraries 38 | 39 | # Mongo Explorer plugin: 40 | # .idea/mongoSettings.xml 41 | 42 | ## File-based project format: 43 | *.ipr 44 | *.iws 45 | 46 | ## Plugin-specific files: 47 | 48 | # IntelliJ 49 | /out/ 50 | 51 | # mpeltonen/sbt-idea plugin 52 | .idea_modules/ 53 | 54 | # JIRA plugin 55 | atlassian-ide-plugin.xml 56 | 57 | # Crashlytics plugin (for Android Studio and IntelliJ) 58 | com_crashlytics_export_strings.xml 59 | crashlytics.properties 60 | crashlytics-build.properties 61 | ### Maven template 62 | target/ 63 | pom.xml.tag 64 | pom.xml.releaseBackup 65 | pom.xml.versionsBackup 66 | pom.xml.next 67 | release.properties 68 | dependency-reduced-pom.xml 69 | buildNumber.properties 70 | .mvn/timing.properties 71 | 72 | /copybin.sh 73 | /Digital.sh 74 | /upload.sh 75 | -------------------------------------------------------------------------------- /Digital.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hneemann/digitalCustomComponents/3e895bac00e390bd8ab3a9ee9ca963edf8f081fb/Digital.jar -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Digital Custom Java Components # 2 | 3 | This is a example project which demonstrates the creation of java implemented custom 4 | components which can be used in the [Digital](https://github.com/hneemann/Digital/) simulator. 5 | 6 | ## How it works ## 7 | 8 | In some cases, it makes sense not to create a special component as a subcircuit, but as a component implemented in Java. 9 | One reason could be to improve the performance of the simulation. Another reason could be a special access to the GUI, 10 | which is only possible if Java code is used. 11 | 12 | This repository shows an example containing two simple components implemented in Java. 13 | 14 | To use these components, you must first create a jar file containing all the necessary classes. 15 | The easiest way is to use `maven`. When the jar is created, you can attach this JAR file to the 16 | simulator by selecting the created JAR file - `pluginExample-1.0-SNAPSHOT.jar` in this example - in 17 | the simulators settings ("Java library"). 18 | 19 | The class `DemoComponentSource.java` contains a `Main` method. This method can be used to debug your 20 | components. To use this method, it is necessary to remove the jar file from the digital settings. 21 | 22 | ## How do I get set up? ## 23 | 24 | The easiest way to build the necessary Jar is to use [maven](https://maven.apache.org/). 25 | 26 | * JDK 1.8 is needed (either the Oracle JDK 1.8 or OpenJDK 1.8) 27 | * Clone the repository. 28 | * Replace the `Digital.jar` which is included in this repo with the version you want to use. 29 | * Rename the DemoComponentSource class as appropriate. 30 | * Also update the new class name in the `pom.xml` 31 | * Implement your components 32 | * After that run `mvn install` to create the library jar file 33 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | de.neemann.digital 8 | pluginExample 9 | 1.0-SNAPSHOT 10 | pluginExample 11 | 12 | 13 | yyyy-MM-dd HH:mm 14 | UTF-8 15 | 16 | 17 | 18 | 19 | 20 | org.apache.maven.plugins 21 | maven-compiler-plugin 22 | 3.1 23 | 24 | 1.8 25 | 1.8 26 | 27 | 28 | 29 | 30 | org.apache.maven.plugins 31 | maven-surefire-plugin 32 | 2.19.1 33 | 34 | 35 | 36 | org.apache.maven.plugins 37 | maven-jar-plugin 38 | 2.5 39 | 40 | 41 | 42 | true 43 | 44 | de.neemann.digital.plugin.DemoComponentSource 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | de.neemann.digital 55 | Digital 56 | 1.0-SNAPSHOT 57 | system 58 | ${basedir}/Digital.jar 59 | 60 | 61 | 62 | junit 63 | junit 64 | 4.0 65 | test 66 | 67 | 68 | 69 | 70 | 71 | -------------------------------------------------------------------------------- /src/main/dig/jarLibTest.dig: -------------------------------------------------------------------------------- 1 | 2 | 3 | 1 4 | 5 | 6 | 7 | In 8 | 9 | 10 | Label 11 | A 12 | 13 | 14 | 15 | 16 | 17 | In 18 | 19 | 20 | Label 21 | B 22 | 23 | 24 | 25 | 26 | 27 | Out 28 | 29 | 30 | Label 31 | AND 32 | 33 | 34 | 35 | 36 | 37 | MyAnd 38 | 39 | 40 | 41 | 42 | Out 43 | 44 | 45 | Label 46 | OR 47 | 48 | 49 | 50 | 51 | 52 | MyOr 53 | 54 | 55 | 56 | 57 | Testcase 58 | 59 | 60 | Testdata 61 | 62 | A B AND OR 63 | 0 0 0 0 64 | 0 1 0 1 65 | 1 0 0 1 66 | 1 1 1 1 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | -------------------------------------------------------------------------------- /src/main/java/de/neemann/digital/plugin/DemoComponentSource.java: -------------------------------------------------------------------------------- 1 | package de.neemann.digital.plugin; 2 | 3 | import de.neemann.digital.draw.library.ComponentManager; 4 | import de.neemann.digital.draw.library.ComponentSource; 5 | import de.neemann.digital.draw.library.ElementLibrary; 6 | import de.neemann.digital.draw.library.InvalidNodeException; 7 | import de.neemann.digital.draw.shapes.GenericShape; 8 | import de.neemann.digital.gui.Main; 9 | 10 | /** 11 | * Adds some components to Digital 12 | */ 13 | public class DemoComponentSource implements ComponentSource { 14 | 15 | /** 16 | * Attach your components to the simulator by calling the add methods 17 | * 18 | * @param manager the ComponentManager 19 | * @throws InvalidNodeException InvalidNodeException 20 | */ 21 | @Override 22 | public void registerComponents(ComponentManager manager) throws InvalidNodeException { 23 | 24 | // add a component and use the default shape 25 | manager.addComponent("my folder/my sub folder", MyAnd.DESCRIPTION); 26 | 27 | // add a component and also provide a custom shape 28 | manager.addComponent("my folder/my sub folder", MyOr.DESCRIPTION, MyOrShape::new); 29 | 30 | // add a component and use the default shape 31 | manager.addComponent("my folder/my sub folder", MultiNot.DESCRIPTION); 32 | 33 | // add a component and use the default shape 34 | manager.addComponent("my folder/RAM", MultiPortRAM.DESCRIPTION, 35 | (attr, inputs, outputs) -> 36 | new GenericShape("RAM", inputs, outputs, attr.getLabel(), true, 5)); 37 | } 38 | 39 | /** 40 | * Start Digital with this ComponentSource attached to make debugging easier. 41 | * IMPORTANT: Remove the jar from Digitals settings!!! 42 | * 43 | * @param args args 44 | */ 45 | public static void main(String[] args) { 46 | new Main.MainBuilder() 47 | .setLibrary(new ElementLibrary().registerComponentSource(new DemoComponentSource())) 48 | .openLater(); 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /src/main/java/de/neemann/digital/plugin/MultiNot.java: -------------------------------------------------------------------------------- 1 | package de.neemann.digital.plugin; 2 | 3 | 4 | import de.neemann.digital.core.*; 5 | import de.neemann.digital.core.element.Element; 6 | import de.neemann.digital.core.element.ElementAttributes; 7 | import de.neemann.digital.core.element.ElementTypeDescription; 8 | import de.neemann.digital.core.element.Keys; 9 | 10 | import static de.neemann.digital.core.element.PinInfo.input; 11 | 12 | /** 13 | * Example of an element that consists of three individual NOT gates which 14 | * are implemented as three nodes which are operating independent of each other. 15 | */ 16 | public class MultiNot implements Element { // A Element is created if the model is generated 17 | 18 | public static final ElementTypeDescription DESCRIPTION = 19 | new ElementTypeDescription(MultiNot.class, 20 | input("I_0"), 21 | input("I_1"), 22 | input("I_2")) 23 | .addAttribute(Keys.BITS); 24 | 25 | private final int bits; 26 | private final ObservableValue out0; 27 | private final ObservableValue out1; 28 | private final ObservableValue out2; 29 | private ObservableValues inputs; 30 | 31 | public MultiNot(ElementAttributes attr) { 32 | bits = attr.getBits(); 33 | out0 = new ObservableValue("O_0", bits); 34 | out1 = new ObservableValue("O_1", bits); 35 | out2 = new ObservableValue("O_2", bits); 36 | } 37 | 38 | /** 39 | * The element has to provide all the output values of the whole component. 40 | * 41 | * @return the outputs available 42 | */ 43 | @Override 44 | public ObservableValues getOutputs() { 45 | return new ObservableValues(out0, out1, out2); 46 | } 47 | 48 | /** 49 | * And the element also receives all the required input values. 50 | * 51 | * @param inputs the inputs 52 | * @throws NodeException NodeException 53 | */ 54 | @Override 55 | public void setInputs(ObservableValues inputs) throws NodeException { 56 | this.inputs = inputs; 57 | for (ObservableValue i : inputs) 58 | i.checkBits(bits, null); 59 | } 60 | 61 | /** 62 | * If this inputs are set this method is called. This method is allowed to 63 | * add several nodes to the model. 64 | * These nodes are operating independent of each other. 65 | * 66 | * @param model the mode which is generated 67 | */ 68 | @Override 69 | public void registerNodes(Model model) { 70 | model.add(new MyNotNode(inputs.get(0), out0)); 71 | model.add(new MyNotNode(inputs.get(1), out1)); 72 | model.add(new MyNotNode(inputs.get(2), out2)); 73 | } 74 | 75 | /** 76 | * The implementation of the NOT gate 77 | */ 78 | private static class MyNotNode extends Node { 79 | private final ObservableValue in; 80 | private final ObservableValue out; 81 | private long value; 82 | 83 | private MyNotNode(ObservableValue in, ObservableValue out) { 84 | // the node has to register itself to the input value. 85 | // Otherwise it is not able to react on an input value change. 86 | this.in = in.addObserverToValue(this); 87 | this.out = out; 88 | } 89 | 90 | @Override 91 | public void readInputs() { 92 | value = in.getValue(); 93 | } 94 | 95 | @Override 96 | public void writeOutputs() { 97 | out.setValue(~value); // invert the input value 98 | } 99 | 100 | @Override 101 | public ObservableValues getOutputs() { 102 | return out.asList(); 103 | } 104 | } 105 | } 106 | -------------------------------------------------------------------------------- /src/main/java/de/neemann/digital/plugin/MultiPortRAM.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2017 Helmut Neemann 3 | * Use of this source code is governed by the GPL v3 license 4 | * that can be found in the LICENSE file. 5 | */ 6 | package de.neemann.digital.plugin; 7 | 8 | import de.neemann.digital.core.*; 9 | import de.neemann.digital.core.element.*; 10 | import de.neemann.digital.core.memory.DataField; 11 | import de.neemann.digital.core.memory.RAMInterface; 12 | 13 | import java.util.ArrayList; 14 | 15 | import static de.neemann.digital.core.element.PinInfo.input; 16 | 17 | /** 18 | * RAM module with different ports to read and write the data 19 | * and an additional read port. Used to implement graphic card memory. 20 | * This example shohs, how to implement a component with a customizable 21 | * number of inputs. 22 | */ 23 | public class MultiPortRAM extends Node implements Element, RAMInterface { 24 | 25 | private static final Key WRITE_PORTS = 26 | new Key.KeyInteger("writePorts", 2) 27 | .setMin(1) 28 | .setComboBoxValues(1, 2, 3, 4, 5) 29 | .setName("Write Ports") 30 | .setDescription("Number of write ports."); 31 | 32 | private static final Key READ_PORTS = 33 | new Key.KeyInteger("readPorts", 2) 34 | .setMin(1) 35 | .setComboBoxValues(1, 2, 3, 4, 5) 36 | .setName("Read Ports") 37 | .setDescription("Number of read ports."); 38 | 39 | /** 40 | * The RAMs {@link ElementTypeDescription} 41 | */ 42 | static final ElementTypeDescription DESCRIPTION = new ElementTypeDescription(MultiPortRAM.class) { 43 | @Override 44 | public PinDescriptions getInputDescription(ElementAttributes elementAttributes) { 45 | int writePorts = elementAttributes.get(WRITE_PORTS); 46 | int readPorts = elementAttributes.get(READ_PORTS); 47 | PinDescription[] names = new PinDescription[writePorts * 3 + readPorts + 1]; 48 | for (int i = 0; i < writePorts; i++) { 49 | names[i * 3] = input("WE" + i, "Write enable pin " + i); 50 | names[i * 3 + 1] = input("WA" + i, "Write Address Bus " + i); 51 | names[i * 3 + 2] = input("WD" + i, "Write Data Bus " + i); 52 | } 53 | for (int i = 0; i < readPorts; i++) 54 | names[i + writePorts * 3] = input("RA" + i, "Read Address Bus " + i); 55 | 56 | names[names.length - 1] = input("C", "Clock Pin").setClock(); 57 | return new PinDescriptions(names); 58 | } 59 | } 60 | .addAttribute(Keys.ROTATE) 61 | .addAttribute(Keys.BITS) 62 | .addAttribute(Keys.ADDR_BITS) 63 | .addAttribute(WRITE_PORTS) 64 | .addAttribute(READ_PORTS) 65 | .addAttribute(Keys.IS_PROGRAM_MEMORY) 66 | .addAttribute(Keys.LABEL); 67 | 68 | private final DataField memory; 69 | private final ObservableValue[] out; 70 | private final int addrBits; 71 | private final int bits; 72 | private final String label; 73 | private final int size; 74 | private final boolean isProgramMemory; 75 | private final int writePortNum; 76 | private final int readPortNum; 77 | private boolean lastClk = false; 78 | private ArrayList writePorts; 79 | private ArrayList readPorts; 80 | private ObservableValue clkIn; 81 | 82 | /** 83 | * Creates a new instance 84 | * 85 | * @param attr the elements attributes 86 | */ 87 | public MultiPortRAM(ElementAttributes attr) { 88 | super(true); 89 | bits = attr.get(Keys.BITS); 90 | 91 | writePortNum = attr.get(WRITE_PORTS); 92 | readPortNum = attr.get(READ_PORTS); 93 | 94 | out = new ObservableValue[readPortNum]; 95 | for (int i = 0; i < readPortNum; i++) 96 | out[i] = new ObservableValue("D" + i, bits).setDescription("Read Data Bus " + i); 97 | 98 | addrBits = attr.get(Keys.ADDR_BITS); 99 | size = 1 << addrBits; 100 | memory = new DataField(size); 101 | label = attr.getLabel(); 102 | isProgramMemory = attr.get(Keys.IS_PROGRAM_MEMORY); 103 | } 104 | 105 | @Override 106 | public void setInputs(ObservableValues inputs) throws NodeException { 107 | writePorts = new ArrayList<>(writePortNum); 108 | for (int i = 0; i < writePortNum; i++) 109 | writePorts.add(new WritePort(inputs.get(i * 3), inputs.get(i * 3 + 1), inputs.get(i * 3 + 2))); 110 | 111 | readPorts = new ArrayList<>(readPortNum); 112 | for (int i = 0; i < readPortNum; i++) 113 | readPorts.add(new ReadPort(inputs.get(writePortNum * 3 + i), out[i])); 114 | 115 | clkIn = inputs.get(inputs.size() - 1).checkBits(1, this).addObserverToValue(this); 116 | } 117 | 118 | @Override 119 | public ObservableValues getOutputs() { 120 | return new ObservableValues(out); 121 | } 122 | 123 | @Override 124 | public void readInputs() { 125 | boolean clk = clkIn.getBool(); 126 | if (clk && !lastClk) 127 | for (WritePort rp : writePorts) 128 | rp.readInputs(); 129 | 130 | lastClk = clk; 131 | for (ReadPort rp : readPorts) 132 | rp.readInput(); 133 | } 134 | 135 | @Override 136 | public void writeOutputs() { 137 | for (ReadPort rp : readPorts) 138 | rp.writeOutput(); 139 | } 140 | 141 | @Override 142 | public DataField getMemory() { 143 | return memory; 144 | } 145 | 146 | @Override 147 | public String getLabel() { 148 | return label; 149 | } 150 | 151 | @Override 152 | public int getSize() { 153 | return size; 154 | } 155 | 156 | @Override 157 | public int getDataBits() { 158 | return bits; 159 | } 160 | 161 | @Override 162 | public int getAddrBits() { 163 | return addrBits; 164 | } 165 | 166 | @Override 167 | public boolean isProgramMemory() { 168 | return isProgramMemory; 169 | } 170 | 171 | @Override 172 | public void setProgramMemory(DataField dataField) { 173 | memory.setDataFrom(dataField); 174 | } 175 | 176 | private final class WritePort { 177 | private final ObservableValue en; 178 | private final ObservableValue a; 179 | private final ObservableValue d; 180 | 181 | private WritePort(ObservableValue en, ObservableValue a, ObservableValue d) throws BitsException { 182 | this.en = en.checkBits(1, MultiPortRAM.this); 183 | this.a = a.checkBits(addrBits, MultiPortRAM.this); 184 | this.d = d.checkBits(bits, MultiPortRAM.this); 185 | } 186 | 187 | private void readInputs() { 188 | if (en.getBool()) { 189 | int addr = (int) a.getValue(); 190 | long data = d.getValue(); 191 | memory.setData(addr, data); 192 | } 193 | } 194 | } 195 | 196 | private final class ReadPort { 197 | private final ObservableValue a; 198 | private final ObservableValue d; 199 | private int addr; 200 | 201 | private ReadPort(ObservableValue a, ObservableValue d) throws BitsException { 202 | this.a = a.checkBits(addrBits, MultiPortRAM.this).addObserverToValue(MultiPortRAM.this); 203 | this.d = d.checkBits(bits, MultiPortRAM.this); 204 | } 205 | 206 | private void readInput() { 207 | addr = (int) a.getValue(); 208 | } 209 | 210 | private void writeOutput() { 211 | d.setValue(memory.getDataWord(addr)); 212 | } 213 | } 214 | } 215 | -------------------------------------------------------------------------------- /src/main/java/de/neemann/digital/plugin/MyAnd.java: -------------------------------------------------------------------------------- 1 | package de.neemann.digital.plugin; 2 | 3 | import de.neemann.digital.core.Node; 4 | import de.neemann.digital.core.NodeException; 5 | import de.neemann.digital.core.ObservableValue; 6 | import de.neemann.digital.core.ObservableValues; 7 | import de.neemann.digital.core.element.Element; 8 | import de.neemann.digital.core.element.ElementAttributes; 9 | import de.neemann.digital.core.element.ElementTypeDescription; 10 | import de.neemann.digital.core.element.Keys; 11 | 12 | import static de.neemann.digital.core.element.PinInfo.input; 13 | 14 | /** 15 | * A simple And component 16 | */ 17 | public class MyAnd extends Node implements Element { 18 | 19 | /** 20 | * The description of the new component 21 | */ 22 | public static final ElementTypeDescription DESCRIPTION 23 | = new ElementTypeDescription(MyAnd.class, 24 | input("a", "and input a"), 25 | input("b", "and input b")) { 26 | 27 | @Override 28 | public String getDescription(ElementAttributes elementAttributes) { 29 | return "A simple AND gate which shows the implementation of a custom component."; 30 | } 31 | 32 | } 33 | .addAttribute(Keys.ROTATE) // allows to rotate the new component 34 | .addAttribute(Keys.BITS); // allows to set a bit number to the component 35 | 36 | 37 | private final int bits; 38 | private final ObservableValue out; 39 | private ObservableValue a; 40 | private ObservableValue b; 41 | private long outValue; 42 | 43 | /** 44 | * Creates a component. 45 | * The constructor is able to access the components attributes and has 46 | * to create the components output signals, which are instances of the {@link ObservableValue} class. 47 | * As soon as the constructor is called you have to expect a call to the getOutputs() method. 48 | * 49 | * @param attr the attributes which are editable in the components properties dialog 50 | */ 51 | public MyAnd(ElementAttributes attr) { 52 | bits = attr.getBits(); 53 | out = new ObservableValue("out", bits).setDescription("and output"); 54 | } 55 | 56 | /** 57 | * This method is called if one of the input values has changed. 58 | * Here you can read the input values of your component. 59 | * It is not allowed to write to one of the outputs!!! 60 | */ 61 | @Override 62 | public void readInputs() { 63 | long valueA = a.getValue(); 64 | long valueB = b.getValue(); 65 | outValue = valueA & valueB; 66 | } 67 | 68 | /** 69 | * This method is called if you have to update your output. 70 | * It is not allowed to read one of the inputs!!! 71 | */ 72 | @Override 73 | public void writeOutputs() { 74 | out.setValue(outValue); 75 | } 76 | 77 | /** 78 | * This method is called to register the input signals which are 79 | * connected to your components inputs. The order is the same as given in 80 | * the {@link ElementTypeDescription}. 81 | * You can store the instances, make some checks and so on. 82 | * IMPORTANT: If it's necessary that your component is called if the input 83 | * changes, you have to call the addObserverToValue method on that input. 84 | * If a combinatorial component is implemented you have to add the observer 85 | * to all inputs. If your component only reacts on a clock signal you only 86 | * need to add the observer to the clock signal. 87 | * 88 | * @param inputs the list of ObservableValues to use 89 | * @throws NodeException NodeException 90 | */ 91 | @Override 92 | public void setInputs(ObservableValues inputs) throws NodeException { 93 | a = inputs.get(0).addObserverToValue(this).checkBits(bits, this); 94 | b = inputs.get(1).addObserverToValue(this).checkBits(bits, this); 95 | } 96 | 97 | /** 98 | * This method must return the output signals of your component. 99 | * 100 | * @return the output signals 101 | */ 102 | @Override 103 | public ObservableValues getOutputs() { 104 | return new ObservableValues(out); 105 | } 106 | } 107 | -------------------------------------------------------------------------------- /src/main/java/de/neemann/digital/plugin/MyOr.java: -------------------------------------------------------------------------------- 1 | package de.neemann.digital.plugin; 2 | 3 | import de.neemann.digital.core.Node; 4 | import de.neemann.digital.core.NodeException; 5 | import de.neemann.digital.core.ObservableValue; 6 | import de.neemann.digital.core.ObservableValues; 7 | import de.neemann.digital.core.element.*; 8 | 9 | import static de.neemann.digital.core.element.PinInfo.input; 10 | 11 | /** 12 | * A custom Or component 13 | */ 14 | public class MyOr extends Node implements Element { 15 | 16 | static final Key ELLIPSE_SIZE = 17 | new Key.KeyInteger("ellipseSize", 2) 18 | .setMin(1) 19 | .setMax(5) 20 | .setComboBoxValues(1, 2, 3, 4, 5) 21 | .setName("Ellipse Size") 22 | .setDescription("Sets the size of the ellipse."); 23 | 24 | /** 25 | * The description of the new component 26 | */ 27 | public static final ElementTypeDescription DESCRIPTION 28 | = new ElementTypeDescription(MyOr.class, 29 | input("a", "or input a"), 30 | input("b", "or input b")) 31 | .addAttribute(Keys.ROTATE) // allows to rotate the new component 32 | .addAttribute(Keys.BITS) // allows to set a bit number to the component 33 | .addAttribute(ELLIPSE_SIZE); // the size of the ellipse 34 | 35 | private final int bits; 36 | private final ObservableValue out; 37 | private ObservableValue a; 38 | private ObservableValue b; 39 | private long outValue; 40 | 41 | /** 42 | * Creates a component. 43 | * The constructor is able to access the components attributes and has 44 | * to create the components output signals, which are instances of the {@link ObservableValue} class. 45 | * As soon as the constructor is called you have to expect a call to the getOutputs() method. 46 | * 47 | * @param attr the attributes which are editable in the components properties dialog 48 | */ 49 | public MyOr(ElementAttributes attr) { 50 | bits = attr.getBits(); 51 | out = new ObservableValue("out", bits).setDescription("The components single output"); 52 | } 53 | 54 | /** 55 | * This method is called if one of the input values has changed. 56 | * Here you can read the input values of your component. 57 | * It is not allowed to write to one of the outputs!!! 58 | */ 59 | @Override 60 | public void readInputs() { 61 | long valueA = a.getValue(); 62 | long valueB = b.getValue(); 63 | outValue = valueA | valueB; 64 | } 65 | 66 | /** 67 | * This method is called if you have to update your output. 68 | * It is not allowed to read one of the inputs!!! 69 | */ 70 | @Override 71 | public void writeOutputs() { 72 | out.setValue(outValue); 73 | } 74 | 75 | /** 76 | * This method is called to register the input signals which are 77 | * connected to your components inputs. The order is the same as given in 78 | * the {@link ElementTypeDescription}. 79 | * You can store the instances, make some checks and so on. 80 | * IMPORTANT: If it's necessary that your component is called if the input 81 | * changes, you have to call the addObserverToValue method on that input. 82 | * If a combinatorial component is implemented you have to add the observer 83 | * to all inputs. If your component only reacts on a clock signal you only 84 | * need to add the observer to the clock signal. 85 | * 86 | * @param inputs the list of ObservableValues to use 87 | * @throws NodeException NodeException 88 | */ 89 | @Override 90 | public void setInputs(ObservableValues inputs) throws NodeException { 91 | a = inputs.get(0).addObserverToValue(this).checkBits(bits, this); 92 | b = inputs.get(1).addObserverToValue(this).checkBits(bits, this); 93 | } 94 | 95 | /** 96 | * This method must return the output signals of your component. 97 | * 98 | * @return the output signals 99 | */ 100 | @Override 101 | public ObservableValues getOutputs() { 102 | return new ObservableValues(out); 103 | } 104 | } 105 | -------------------------------------------------------------------------------- /src/main/java/de/neemann/digital/plugin/MyOrShape.java: -------------------------------------------------------------------------------- 1 | package de.neemann.digital.plugin; 2 | 3 | import de.neemann.digital.core.ObservableValue; 4 | import de.neemann.digital.core.Value; 5 | import de.neemann.digital.core.element.ElementAttributes; 6 | import de.neemann.digital.core.element.PinDescriptions; 7 | import de.neemann.digital.draw.elements.IOState; 8 | import de.neemann.digital.draw.elements.Pin; 9 | import de.neemann.digital.draw.elements.Pins; 10 | import de.neemann.digital.draw.graphics.Graphic; 11 | import de.neemann.digital.draw.graphics.Orientation; 12 | import de.neemann.digital.draw.graphics.Style; 13 | import de.neemann.digital.draw.shapes.InteractorInterface; 14 | import de.neemann.digital.draw.shapes.Shape; 15 | 16 | import static de.neemann.digital.draw.graphics.Vector.vec; 17 | import static de.neemann.digital.draw.shapes.GenericShape.SIZE; 18 | import static de.neemann.digital.draw.shapes.GenericShape.SIZE2; 19 | 20 | /** 21 | * A shape for the new Or component 22 | */ 23 | public class MyOrShape implements Shape { 24 | private final PinDescriptions inputs; 25 | private final PinDescriptions outputs; 26 | private final int ellipseSize; 27 | private ObservableValue output; 28 | private Value actualOutputValue; 29 | 30 | /** 31 | * Creates a new instance. 32 | * 33 | * @param elementAttributes the attributes of the component 34 | * @param inputs the inputs 35 | * @param outputs the outputs 36 | */ 37 | public MyOrShape(ElementAttributes elementAttributes, PinDescriptions inputs, PinDescriptions outputs) { 38 | this.inputs = inputs; 39 | this.outputs = outputs; 40 | ellipseSize = elementAttributes.get(MyOr.ELLIPSE_SIZE); 41 | } 42 | 43 | /** 44 | * Defines a positions for each input and output. 45 | * CAUTION: The coordinates needs to be multiple of the grid size! 46 | * 47 | * @return the pins to draw 48 | */ 49 | @Override 50 | public Pins getPins() { 51 | return new Pins() 52 | .add(new Pin(vec(0, 0), inputs.get(0))) 53 | .add(new Pin(vec(0, SIZE * 2), inputs.get(1))) 54 | .add(new Pin(vec(SIZE * 3, SIZE), outputs.get(0))); 55 | } 56 | 57 | /** 58 | * This method call connects the created model element to the shape which represents the model node. 59 | * If the look of the shape depends on an input or output state, the shape has to register the 60 | * guiObserver to all of the input or output ObservableValue instances it depends on. 61 | * To access the actual state while drawing, the Shape needs to store the IOState or the needed inputs 62 | * or outputs in a member variable. 63 | * This shape should reflect the output state, so we have to register the shape to the output value and 64 | * keep the {@link ObservableValue} representing the output for later use. 65 | * In this case null is returned because there is no user interaction with the shape. 66 | * 67 | * @param ioState The state of the element. Is never null. 68 | * @return The interactor which is used to interact with the shape during the simulation. 69 | */ 70 | @Override 71 | public InteractorInterface applyStateMonitor(IOState ioState) { 72 | output = ioState.getOutput(0); 73 | return null; 74 | } 75 | 76 | /** 77 | * The draw method is not allowed to access the model, thus the draw method can not read the output state 78 | * of the OR gate. To do so, this method is used to read values from the model. 79 | * During execution of this method the model is locked. Thus this method should return as fast as possible. 80 | */ 81 | @Override 82 | public void readObservableValues() { 83 | // The output is null if you are in edit mode and therefore no model is running, 84 | if (output != null) 85 | actualOutputValue = output.getCopy(); 86 | } 87 | 88 | /** 89 | * Draw the component. 90 | * This method is not allowed to access the model! 91 | * Use the readObservableValues method to pick the necessary values from the model. 92 | * 93 | * @param graphic interface to draw to 94 | * @param highLight Null means no highlighting at all. If highlight is not null, highlighting is active. 95 | * The given style should be used to highlight the drawing. 96 | */ 97 | @Override 98 | public void drawTo(Graphic graphic, Style highLight) { 99 | 100 | // The actualOutputValue is null if you are in edit mode and therefore no model is running, 101 | if (actualOutputValue != null) { 102 | 103 | // get the color style representing the actual state of the output value 104 | final Style wireStyle = Style.getWireStyle(actualOutputValue); 105 | 106 | // draw a somewhat smaller ellipse inside the outer one using the wireStyle 107 | graphic.drawCircle(vec(SIZE2, SIZE2 - SIZE * (ellipseSize - 1)), vec(SIZE * 2 + SIZE2, SIZE2 + SIZE * ellipseSize), wireStyle); 108 | } else { 109 | // in edit mode draw a thin ellipse instead 110 | graphic.drawCircle(vec(SIZE2, SIZE2 - SIZE * (ellipseSize - 1)), vec(SIZE * 2 + SIZE2, SIZE2 + SIZE * ellipseSize), Style.THIN); 111 | } 112 | 113 | // draw the outer ellipse 114 | graphic.drawCircle(vec(0, SIZE - SIZE * ellipseSize), vec(SIZE * 3, SIZE + SIZE * ellipseSize), Style.NORMAL); 115 | // draw the text "Or" 116 | graphic.drawText(vec(SIZE * 3 / 2, SIZE), vec(1, SIZE), "Or", Orientation.CENTERCENTER, Style.NORMAL); 117 | } 118 | } 119 | -------------------------------------------------------------------------------- /src/main/java/de/neemann/digital/plugin/package-info.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Demonstrates the the implementation of jar components. 3 | */ 4 | package de.neemann.digital.plugin; 5 | -------------------------------------------------------------------------------- /src/main/resources/vhdl/DIG_MyAnd.tem: -------------------------------------------------------------------------------- 1 | LIBRARY ieee; 2 | USE ieee.std_logic_1164.all; 3 | USE ieee.std_logic_unsigned.all; 4 | 5 | 8 | 9 | entity DIG_MyAnd is 10 | port ( 11 | y: out std_logic; 12 | a: in std_logic; 13 | b: in std_logic ); 14 | end DIG_MyAnd; 15 | 16 | architecture Behavioral of DIG_MyAnd is 17 | begin 18 | y <= a AND b; 19 | end Behavioral; 20 | 21 | 23 | 24 | entity DIG_MyAnd_Bus is 25 | generic ( Bits: integer ); 26 | port ( 27 | y: out std_logic_vector((Bits-1) downto 0); 28 | a: in std_logic_vector((Bits-1) downto 0); 29 | b: in std_logic_vector((Bits-1) downto 0) ); 30 | end DIG_MyAnd_Bus; 31 | 32 | architecture Behavioral of DIG_MyAnd_Bus is 33 | begin 34 | y <= a AND b; 35 | end Behavioral; 36 | 37 | 38 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /src/test/java/de/neemann/digital/plugin/MyComponentsTest.java: -------------------------------------------------------------------------------- 1 | package de.neemann.digital.plugin; 2 | 3 | import de.neemann.digital.core.Model; 4 | import de.neemann.digital.core.NodeException; 5 | import de.neemann.digital.core.ObservableValue; 6 | import de.neemann.digital.core.element.ElementAttributes; 7 | import de.neemann.digital.draw.elements.PinException; 8 | import junit.framework.TestCase; 9 | 10 | import static de.neemann.digital.core.ObservableValues.ovs; 11 | 12 | /** 13 | * Simple table driven tests to test the custom MyAnd and MyOr components 14 | */ 15 | public class MyComponentsTest extends TestCase { 16 | 17 | private static class TestTableRow { 18 | int a; 19 | int b; 20 | int myAnd; 21 | int myOr; 22 | 23 | TestTableRow(int a, int b, int myAnd, int myOr) { 24 | this.a = a; 25 | this.b = b; 26 | this.myAnd = myAnd; 27 | this.myOr = myOr; 28 | } 29 | } 30 | 31 | private static TestTableRow[] table = new TestTableRow[]{ 32 | new TestTableRow(0, 0, 0, 0), 33 | new TestTableRow(0, 1, 0, 1), 34 | new TestTableRow(1, 0, 0, 1), 35 | new TestTableRow(1, 1, 1, 1), 36 | }; 37 | 38 | 39 | public void testMyAnd() throws NodeException, PinException { 40 | ObservableValue a = new ObservableValue("a", 1); 41 | ObservableValue b = new ObservableValue("b", 1); 42 | 43 | Model model = new Model(); 44 | MyAnd myAnd = model.add(new MyAnd(new ElementAttributes())); 45 | myAnd.setInputs(ovs(a, b)); 46 | ObservableValue out = myAnd.getOutputs().get(0); 47 | model.init(); 48 | 49 | for (TestTableRow row : table) { 50 | a.setValue(row.a); 51 | b.setValue(row.b); 52 | model.doStep(); 53 | assertEquals(row.myAnd, out.getValue()); 54 | } 55 | } 56 | 57 | public void testMyOr() throws NodeException, PinException { 58 | ObservableValue a = new ObservableValue("a", 1); 59 | ObservableValue b = new ObservableValue("b", 1); 60 | 61 | Model model = new Model(); 62 | MyOr myOr = model.add(new MyOr(new ElementAttributes())); 63 | myOr.setInputs(ovs(a, b)); 64 | ObservableValue out = myOr.getOutputs().get(0); 65 | model.init(); 66 | 67 | for (TestTableRow row : table) { 68 | a.setValue(row.a); 69 | b.setValue(row.b); 70 | model.doStep(); 71 | assertEquals(row.myOr, out.getValue()); 72 | } 73 | } 74 | 75 | } --------------------------------------------------------------------------------